Doc changelog #115

yardasol · 2022-01-31T16:11:55Z

Summary of changes

This PR adds several features related to change logs/release notes. Specifically, this PR adds:

A new section in the docs, releasenotes
A template for writing release notes
Workflows that:
- Auto-populate the current draft release body with the associated release notes whenever those release notes are updated
- Create a new milestone, draft release, and release notes one minor version higher than the current draft release when the current draft release gets published
- ~~Do the same as above but for micro versions (manual trigger only)~~
New content to CONTRIBUTING.md describing the release notes requirements
A new devguide section in the docs, consisting of
- The landing page
- Conversion of CONTRIBUTING.md to .rst
A new checkbox in the PR template that requires users to document their changes in the release notes for the current milestone.
Acknowledgement of OpenMC's doc structure and the use of sphinx-multiversion to make versioned documentation.

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Required for Merging

Associated Issues and PRs

Issue: closes Feature: Add changelog to docs #105

Associated Developers

Dev: @munkm

Checklist for Reviewers

Reviewers should use this link to get to the
Review Checklist before they begin their review.

abachma2

Overall, this looks good. Do you need a next-release-major?

abachma2 · 2022-02-01T19:35:57Z

.github/workflows/deploy-docs.yml

-    branches:
-      - master 


Does this remove pushing the updates to the master branch? Or does this do something else?

That's exactly what it does!

Is there any reason you are removing this? Does pushing to the master branch trigger this workflow?

I'm removing this because we only need to trigger the workflow when there are changes to the source code (which is what the API documentation is based on) or when there are new doc pages (in the doc folder). We don't need to trigger this workflow when we add/edit workflows or configuration files.

abachma2 · 2022-02-01T19:51:37Z

doc/devguide/contributing.rst

+Contributing
+============
+
+Thanks for Your Help!
+---------------------


Is there a reason the information from the CONTRIBUTING.md file is repeated here?

Yes. It's the web-discoverable version decoupled from github.

So this is what ends up on the webpage separate from the repo?

I used pandoc to generate the .rst file from the .md file

abachma2 · 2022-02-01T19:56:20Z

saltproc/version.py

-_version_minor = 3
-_version_micro = '1'  # use '' for first of series, number for 1 and above
+_version_minor = 4
+_version_micro = '0'  # use '' for first of series, number for 1 and above


Why do you have a 0 here? Based on the comment, shouldn't it be ''?

I think I tried that once and had issues. I can check again though

I read over this again and the reason we have a 0 there is because we are also using the _version_extra to signify that this version is in development and not a release version.

Would you mind changing the comment to reflect this?

I read this over again and now I agree with you

yardasol · 2022-02-01T20:58:38Z

@abachma2 to answer your question about next-version-major.yml, at some point yes we will want one, but we have not hit a major release version yet. It will have the same structure at next-version-micro.yml.

… file

yardasol · 2022-02-02T21:47:24Z

In my meeting with @munkm this morning, we discussed removing the next_release_micro.yml workflow as it doesn't really make sense to have with our current release model. It is technically cruft, so I'll be removing it from this PR and putting it in a new feature branch, branched-releases, where we can more rigorously implement the needed workflow as discussed in #116.

.github/workflows/next-release-minor.yml

abachma2

Looks good!

…gelog Doc changelog 4104bf1

yardasol added 30 commits January 29, 2022 11:37

created releasenotes template

6bff0bc

add section on api changes to template.rst

da9c84a

creaetd 0.4.0 release notes

5d4c0c5

Added index.rst for releasenotes

95ef0ac

update releasenotes template

e5e6b56

add releasenotes to main index.rst

597b68e

typo fix in doc/index.rst

470907d

typo fixes in releasenotes/0.4.0.rst

3347254

Add checkbox for filling out changelog to pr template

999086b

inital version of workflow to populate releasenotes

d738e32

testing of github api

9a9e761

more testing

950b4d9

more testing

c91c590

more testing

805780b

more testing

d35851f

more testing

4eee1d3

more testing

bc08bf1

more testing

63548d2

more testing

a5bf05c

more testing

9f0742d

try adding GITHUB_TOKEN to gh auth request

587cbbb

try adding GITHUB_TOKEN to gh auth request

fdb7041

try following gh api isntructions for gh actions

6efe393

typo fix for jq

496761b

typo fix for jq

11b3dcd

0.4.0.rst -> v0.4.0.rst

9207c71

typo fix for pandoc

cba504c

v0.3.0.rst -> v0.4.0.rst

21833e2

use conda; update pandoc installation

25d8856

try making RELEASE_VERSION an environment variable

50bf57d

yardasol requested review from gwenchee, smpark7 and nsryan2 February 1, 2022 16:24

yardasol added Status:5-In Review and removed Status:4-In Progress labels Feb 1, 2022

abachma2 reviewed Feb 1, 2022

View reviewed changes

yardasol added 3 commits February 1, 2022 15:17

added lines to allow automatic updating of version spec in version.py…

9c6c9d5

… file

added lines to allow automatic updating of version spec in version.py…

dd0691e

… file

fix typos in regular expressions

834c474

yardasol mentioned this pull request Feb 2, 2022

Feature: Branched release model #116

Open

2 tasks

remove next-release-micro.yml

88c5d64

yardasol linked an issue Feb 3, 2022 that may be closed by this pull request

Feature: More detailed error messages #118

Open

8 tasks

yardasol removed a link to an issue Feb 3, 2022

Feature: More detailed error messages #118

Open

8 tasks

yardasol and others added 3 commits February 7, 2022 14:41

add beginning-of-line chars to regexs where needed

60608a6

remove where not needed in _version_micro

7f25cd4

Merge branch 'master' into doc-changelog

beaf8a6

yardasol requested a review from abachma2 February 7, 2022 22:09

yardasol commented Feb 7, 2022

View reviewed changes

.github/workflows/next-release-minor.yml Outdated Show resolved Hide resolved

Update .github/workflows/next-release-minor.yml

0ee8734

abachma2 approved these changes Feb 7, 2022

View reviewed changes

abachma2 merged commit 4104bf1 into arfc:master Feb 7, 2022

github-actions bot pushed a commit that referenced this pull request Feb 7, 2022

update docs at commit: Merge pull request #115 from yardasol/doc-chan…

8b274ef

…gelog Doc changelog 4104bf1

This was referenced Feb 7, 2022

[Bug]: Update 0.4.0 release notes #121

Closed

Fix v0.4.0 releasenotes + templates #122

Merged

yardasol removed the Status:5-In Review label Feb 8, 2022

yardasol deleted the doc-changelog branch March 9, 2022 19:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Doc changelog #115

Doc changelog #115

yardasol commented Jan 31, 2022 •

edited

Loading

abachma2 left a comment •

edited

Loading

abachma2 Feb 1, 2022

yardasol Feb 1, 2022

abachma2 Feb 1, 2022

yardasol Feb 1, 2022

abachma2 Feb 1, 2022

yardasol Feb 1, 2022

abachma2 Feb 1, 2022

yardasol Feb 1, 2022

yardasol Feb 1, 2022

abachma2 Feb 1, 2022

yardasol Feb 1, 2022 •

edited

Loading

yardasol Feb 1, 2022

abachma2 Feb 7, 2022

yardasol Feb 7, 2022

yardasol commented Feb 1, 2022

yardasol commented Feb 2, 2022

abachma2 left a comment

Doc changelog #115

Doc changelog #115

Conversation

yardasol commented Jan 31, 2022 • edited Loading

Summary of changes

Types of changes

Required for Merging

Associated Issues and PRs

Associated Developers

Checklist for Reviewers

abachma2 left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yardasol Feb 1, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yardasol commented Feb 1, 2022

yardasol commented Feb 2, 2022

abachma2 left a comment

Choose a reason for hiding this comment

yardasol commented Jan 31, 2022 •

edited

Loading

abachma2 left a comment •

edited

Loading

yardasol Feb 1, 2022 •

edited

Loading