Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds sunpy package template functionality #664

Closed
wants to merge 6 commits into from

Conversation

CyclingNinja
Copy link
Member

Adds sunpy package template automation using cruft and cookiecutter
Removes some configuration files which would now duplicate functionality

- id: mixed-line-ending
exclude: ".*(.fits|.fts|.fit|.header|.txt|tca.*)$"
- repo: https://github.com/codespell-project/codespell
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh codespell didn't make it to the template?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment on lines 62 to 63
ci:
autofix_prs: false
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This didn't either?
We should also disable updates if the plan is to roll them out via the template?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should add this to the template, asap.

We should also disable updates if the plan is to roll them out via the template?

hmm, this is a good and interesting question. Yes, we should roll out updates via the template, this would mean we go from one (pre-commit) to one (template update) auto PR rather than one to two. We should figure out how we can automate bumping the versions in the template though or they will surely get forgotten.

sunpy/package-template#33

]

[project.urls]
repository = "https://docs.sunpy.org/projects/ndcube/"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should expand these with docs and repository and homepage?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@@ -1,30 +0,0 @@
#!/usr/bin/env python
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought this file had to stay?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll stick it back in (first time using the interactive git add functoinality on kraken)

@nabobalis
Copy link
Contributor

Looks like actions did not start?

@@ -1,3 +1,4 @@
{% set default_python = '3.10' %}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This shouldn't be here 🤔

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

jobs:
core:
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@v1
uses: OpenAstronomy/github-actions-workflows/.github/workflows/tox.yml@main
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should change the template to use v1 not main.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When doing this manual retemplating we should keep all the extra stuff in files like this until it's updated in the template.

Comment on lines 62 to 63
ci:
autofix_prs: false
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should add this to the template, asap.

We should also disable updates if the plan is to roll them out via the template?

hmm, this is a good and interesting question. Yes, we should roll out updates via the template, this would mean we go from one (pre-commit) to one (template update) auto PR rather than one to two. We should figure out how we can automate bumping the versions in the template though or they will surely get forgotten.

sunpy/package-template#33

]

[project.urls]
repository = "https://docs.sunpy.org/projects/ndcube/"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nabobalis nabobalis closed this Apr 22, 2024
@nabobalis
Copy link
Contributor

Replaced by #672

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants