-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #7 from atwilso/main
Merge 1.7.1 release
- Loading branch information
Showing
54 changed files
with
1,565 additions
and
2,598 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,75 +1,124 @@ | ||
|
||
<!-- | ||
This template is for creating a Tracktable release that will go out to the world. | ||
This template is for creating a Tracktable release that will go out to the world. | ||
--> | ||
|
||
# Public Tracktable release | ||
|
||
Documentation on this process is available on the wiki for the Tracktable GitLab repository. | ||
|
||
### Version Number | ||
|
||
<!-- | ||
<!-- | ||
Example: 1.3.1 | ||
--> | ||
|
||
### Major/Minor/Patch release? | ||
|
||
<!-- | ||
Example: Patch | ||
--> | ||
|
||
### Major features in this release | ||
|
||
<!-- | ||
Example: Interactive trajectory rendering using Folium | ||
--> | ||
|
||
### Major bug fixes in this release | ||
|
||
<!-- | ||
Example: Python interpreter crashes on import | ||
--> | ||
|
||
### Checklist | ||
|
||
- [ ] Create release branch and accompanying merge request from `develop` | ||
- [ ] Bump Tracktable version number in `version.txt` | ||
- [ ] Bump Libtool version numbers in `version.txt` | ||
- Reference https://www.gnu.org/software/libtool/manual/html_node/Libtool-versioning.html on how to update the Libtool version | ||
- [ ] Release Notes | ||
- [ ] Compile from issues since previous version | ||
- [ ] Note known issues | ||
- [ ] Add release notes to RTD changelog (remember it's in `reST` format and title/section underlines *must* match) | ||
- [ ] Push to release branch | ||
- [ ] Merge release branch | ||
- [ ] Merge `develop` into main | ||
- [ ] Create a release tag on `main` | ||
- [ ] Push Tracktable `main` to `sandialabs/tracktable` on GitHub | ||
- [ ] Push Tracktable-Data `main` to `sandialabs/tracktable-data` on GitHub | ||
- If Tracktable-Data was untouched or recently released then this step can be skipped | ||
- [ ] Push Tracktable-Docs `main` to `sandialabs/tracktable-docs` on GitHub | ||
- [ ] Create GitHub release under `sandialabs/tracktable` | ||
- [ ] Create release branch from `develop` | ||
- [ ] Bump Libtool version numbers | ||
- [ ] Bump version numbers | ||
* [ ] Top-level CMakeLists.txt | ||
* [ ] Documentation/conf.py | ||
* [ ] Documentation/conf.py.in | ||
* [ ] Documentation/readthedocs/Doxyfile-readthedocs | ||
* [ ] tracktable/Python/tracktable/__init__.py | ||
- [ ] Wheels | ||
- [ ] Build Wheels (Trigger release build pipeline in Gitlab CI/CD against `main` branch, build time: ~2 hours) | ||
* [ ] Build Tracktable Data Wheel | ||
* [ ] Build Tracktable Wheels | ||
- [ ] Linux | ||
- [ ] Windows | ||
- [ ] MacOS | ||
- [ ] Generate GPG signatures | ||
- [ ] Upload wheels to PyPI | ||
- [ ] Upload to GitHub release's assets | ||
- [ ] Anaconda Package (Do these steps on a branch in a fork of `conda-forge/tracktable-feedstock` after the code is released on GitHub) | ||
- [ ] Create release branch | ||
- [ ] Update version number | ||
- [ ] (Optional) Update build number if subsequent build of the same version otherwise build number is `0` | ||
- [ ] Update sha256 value | ||
- Command for getting sha256 value is: `curl -sL {GitHub source code tarball url} | openssl sha256` i.e. `curl -sL https://GitHub.com/sandialabs/tracktable/archive/refs/tags/v<release tag version>.tar.gz | openssl sha256` | ||
- [ ] Push changes to branch | ||
- [ ] Open PR to merge into upstream master | ||
* [ ] Test all wheels to make sure they import correctly | ||
* [ ] Upload wheels to PyPI using `twine` (note: see wiki for instructions on generating API token) | ||
- [ ] Release Notes | ||
* [ ] Include all merge requests since previous release in CHANGELOG.md | ||
* [ ] Write human-readable release notes in RELEASE_NOTES.md | ||
- [ ] Describe new features | ||
- [ ] Note known issues | ||
* [ ] Check into release branch | ||
- [ ] Documentation | ||
- [ ] Build | ||
- The documentation *should've* been built during the CI/CD Build | ||
- [ ] `.tar.gz` file | ||
- [ ] `.zip` file | ||
- [ ] Upload to GitHub release's assets | ||
- [ ] Include links on Documentation page | ||
* [ ] Build | ||
* [ ] `.tar.gz` file | ||
* [ ] `.tar.bz2` file | ||
* [ ] `.zip` file | ||
* [ ] Include links on Documentation page | ||
- [ ] Example Notebooks | ||
- [ ] Clear notebooks of output | ||
- [ ] `.tar.gz` file | ||
- [ ] `.zip` file | ||
- [ ] Upload to GitHub release's assets | ||
- [ ] Include links on Documentation page | ||
* [ ] `.tar.gz` file | ||
* [ ] `.tar.bz2` file | ||
* [ ] `.zip` file | ||
* [ ] Include links on Documentation page | ||
- [ ] Source Code | ||
* [ ] Check out clean copy | ||
* [ ] Delete `.git` directory | ||
* [ ] Make `.tar.gz` version | ||
* [ ] Make `.tar.bz2` version | ||
* [ ] Make `.zip` version | ||
- [ ] GitHub Releases | ||
* [ ] tracktable-data | ||
- [ ] Upload release from Sandia to GitHub | ||
* [ ] Push tracktable-data main to personal repository on GitHub | ||
* [ ] Open pull request to merge into tracktable-data | ||
* [ ] Approve pull request | ||
- [ ] Create GitHub release - see wiki for instructions | ||
* [ ] tracktable-docs | ||
- [ ] Upload release from Sandia to GitHub | ||
* [ ] Push tracktable-data main to personal repository on GitHub | ||
* [ ] Open pull request to merge into tracktable-data | ||
* [ ] Approve pull request | ||
- [ ] Create GitHub release - see wiki for instructions | ||
* [ ] tracktable | ||
- [ ] Upload release from Sandia to GitHub | ||
* [ ] Push tracktable-data main to personal repository on GitHub | ||
* [ ] Open pull request to merge into tracktable-data | ||
* [ ] Approve pull request | ||
- [ ] Create GitHub release - see wiki for instructions | ||
* [ ] Add auxiliary files | ||
- [ ] Documentation | ||
- [ ] Source code (`tracktable` only) | ||
- [ ] Source code (everything included) | ||
- [ ] Wheels | ||
- Anaconda Packages - see wiki for instructions; depends on GitHub releases | ||
* [ ] tracktable-data | ||
- [ ] Fork `github.com/conda-forge/tracktable-data-feedstock` | ||
- [ ] Create release branch | ||
- [ ] Update `meta.yaml` | ||
- [ ] Push to GitHub | ||
- [ ] Open pull request back into source repository | ||
- This list will be updated when we learn what happens after that | ||
* [ ] tracktable | ||
- [ ] Fork `github.com/conda-forge/tracktable-feedstock` | ||
- [ ] Create release branch | ||
- [ ] Update `meta.yaml` | ||
- [ ] Push to GitHub | ||
- [ ] Open pull request back into source repository | ||
- This list will be updated when we learn what happens after that | ||
- [ ] Web Site | ||
- [ ] Announcement on front page | ||
- [ ] Release Notes | ||
- [ ] Links to new documentation | ||
- [ ] Links to new example notebooks | ||
- [ ] Links to wheels | ||
- [ ] Links to Anaconda package | ||
- [ ] Links to source code | ||
* [ ] Announcement on front page | ||
* [ ] Release Notes | ||
* [ ] Links to new documentation | ||
* [ ] Links to new example notebooks | ||
* [ ] Links to wheels | ||
* [ ] Links to source code | ||
- [ ] Announcement | ||
- [ ] Send to tracktable-develop | ||
- [ ] Finalize | ||
- [ ] Publish updates to `https://tracktable.sandia.gov` | ||
* [ ] Send to tracktable-develop |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.