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

ci(release): track deprecations in release notes #1329

Merged
merged 2 commits into from
Aug 17, 2023

Conversation

wpbonelli
Copy link
Contributor

@wpbonelli wpbonelli commented Aug 6, 2023

  • add script doc/mf6io/mf6ivar/deprecations.py to scrape DFNs and generate markdown table
  • run deprecations script in docs.yml CI and upload result file as artifact
  • add mk_deprecations.py script to convert markdown to LaTeX table
  • update build_docs.py to include deprecations in release notes
  • add deprecation policy section to DEVELOPER.md
  • add deprecations page to ReadTheDocs

@wpbonelli wpbonelli force-pushed the track-deprecations branch 4 times, most recently from 00d4062 to 25ee500 Compare August 7, 2023 20:44
@wpbonelli wpbonelli marked this pull request as ready for review August 7, 2023 20:48
@wpbonelli wpbonelli force-pushed the track-deprecations branch 3 times, most recently from b004f90 to 8ba2360 Compare August 8, 2023 15:11
@wpbonelli
Copy link
Contributor Author

Inserts a new section Deprecations into release notes, e.g.

Screenshot 2023-08-08 at 12 33 11 PM

sample from test run here

Copy link
Contributor

@langevin-usgs langevin-usgs left a comment

Choose a reason for hiding this comment

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

Nice job. This looks ready to me. Minor edits included in this review.

DEVELOPER.md Outdated Show resolved Hide resolved
DEVELOPER.md Outdated Show resolved Hide resolved
DEVELOPER.md Outdated Show resolved Hide resolved
DEVELOPER.md Outdated Show resolved Hide resolved
* add script doc/mf6io/mf6ivar/deprecations.py to scrape DFNs and generate markdown table
* run deprecations script in docs.yml CI and upload result file as artifact
* add deprecations page to ReadTheDocs
* add mk_deprecations.py script to convert markdown deprecations to LaTeX table
* include deprecations in release notes
* add deprecation policy section to DEVELOPER.md
@wpbonelli
Copy link
Contributor Author

thanks @langevin-usgs edits applied.

@wpbonelli wpbonelli merged commit 6ffb187 into MODFLOW-USGS:develop Aug 17, 2023
45 checks passed
@wpbonelli wpbonelli deleted the track-deprecations branch August 17, 2023 18:47
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