Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion cookiecutter.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,21 @@
"documentation_url": "Documentation URL, optional",
"changelog_url": "URL to the changelog, optional",
"issue_tracker_url": "URL to the issue tracker, optional"
}
},
"all_repos" : [
"sunpy/sunpy",
"sunpy/ndcube",
"sunpy/sunkit-magex",
"sunpy/streamtracer",
"sunpy/sunkit-dem",
"sunpy/mpl-animators",
"sunpy/sunkit-image",
"sunpy/sunkit-pyvista",
"sunpy/sunpy-soar",
"sunpy/sunkit-instruments",
"sunpy/drms",
"sunpy/sunraster",
"sunpy/sunkit-spex",
"sunpy/radiospectra"
]
}
31 changes: 31 additions & 0 deletions {{ cookiecutter.package_name }}/.github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -122,3 +122,34 @@ jobs:
{%- endif %}
secrets:
pypi_token: {{ '${{ secrets.pypi_token }}' }}
{%- if cookiecutter.github_repo in cookiecutter.all_repos %}
release:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

the release workflow will now be updated in particular packages.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

the needed repos are taken from this

Copy link
Member

Choose a reason for hiding this comment

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

What is the reason for this?

Copy link
Contributor Author

@ankitkhushwaha ankitkhushwaha Feb 11, 2025

Choose a reason for hiding this comment

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

the release is published in these packages. (Seen a list of repos in package-template/tools/batchpr_manual_cruft_update.py)

"all_repos": ["sunpy/sunpy", "sunpy/ndcube", "sunpy/sunkit-magex", "sunpy/streamtracer", "sunpy/sunkit-dem",  
              "sunpy/mpl-animators", "sunpy/sunkit-image", "sunpy/sunkit-pyvista", "sunpy/sunpy-soar", "sunpy/sunkit-   "sunpy/drms", "sunpy/sunraster", "sunpy/sunkit-spex", "sunpy/radiospectra"]

thats' why i thought only to sync release workflow code in these packages only.

Copy link
Member

Choose a reason for hiding this comment

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

But why does it need to be synced to those packages? What happens if we add more?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

there are some packages like data, sunpy-1.0-paper, github-actions-workflows, where i think there is no need to add the release workflow code in these repo.

Should i remove this line ?

Copy link
Member

Choose a reason for hiding this comment

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

Are those repositories tempted? Do they ever get a release?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

sunpy-paper has release but it is archived now.

data doesn't have release

if: startsWith(github.ref, 'refs/tags/v')
runs-on: ubuntu-latest
permissions:
contents: write
actions: none
checks: none
deployments: none
steps:
- name: Checkout repository
uses: actions/checkout@v3
- name: Install Pandoc
run: sudo apt-get update && sudo apt-get install -y pandoc
- name: Generate GitHub Release Notes
run: |
pip install bleach
pandoc --wrap=none -t markdown_strict CHANGELOG.rst > notes.md
python3 -c "import bleach, sys; print(bleach.clean(sys.stdin.read()))" < notes.md > release_notes.md
{ echo "RELEASE_BODY<<EOF"; cat release_notes.md; echo "EOF"; } >> $GITHUB_ENV
- name: Create GitHub Release
uses: "actions/[email protected]"
env:
GITHUB_TOKEN: {{ '${{ secrets.GITHUB_TOKEN }}' }}
with:
tag_name: {{ '${{ github.ref }}' }}
release_name: {{ '${{ github.ref_name }}' }}
body: {{ '${{ env.RELEASE_BODY }}' }}
draft: false
prerelease: false
{%- endif %}