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.

Sign up for GitHub

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

Jump to bottom

Documentation update: releases #2273

Closed
pbanaszkiewicz opened this issue Nov 4, 2022 · 0 comments · Fixed by #2276
Closed

Documentation update: releases #2273

pbanaszkiewicz opened this issue Nov 4, 2022 · 0 comments · Fixed by #2276
Assignees
@pbanaszkiewicz
Labels
component: documentation type: new feature
Milestone
v4.0.5

Comments

@pbanaszkiewicz
Copy link
Contributor

  1. Update documentation to link to releases directory on GH (currently the release notes are not accessible easily).
  2. Switch keeping release notes to a CHANGELOG format: https://keepachangelog.com/en/1.0.0/
  3. Update procedures
  4. Create script for reading updates from GH pull requests - this script should make creating CHANGELOG faster and easier.
@pbanaszkiewicz pbanaszkiewicz self-assigned this Nov 4, 2022
@pbanaszkiewicz pbanaszkiewicz mentioned this issue Nov 5, 2022
Merged
pbanaszkiewicz added a commit to pbanaszkiewicz/amy that referenced this issue Nov 5, 2022
@pbanaszkiewicz
[carpentries#2273] Update links to release notes
abd7ed3
pbanaszkiewicz added a commit to pbanaszkiewicz/amy that referenced this issue Nov 5, 2022
@pbanaszkiewicz
[carpentries#2273] WIP: script to generate changelog for a given mile…
648ee19 
…stone
pbanaszkiewicz added a commit to pbanaszkiewicz/amy that referenced this issue Nov 6, 2022
@pbanaszkiewicz
[carpentries#2273] Generate changelog script
4bc9910
pbanaszkiewicz added a commit to pbanaszkiewicz/amy that referenced this issue Nov 6, 2022
@pbanaszkiewicz
[carpentries#2273] Add changelog generated with a script since v4.0 r…
ebc4661 
…elease
pbanaszkiewicz added a commit to pbanaszkiewicz/amy that referenced this issue Nov 6, 2022
@pbanaszkiewicz
[carpentries#2273] Link docs to changelog.md on GH
bada4ea
pbanaszkiewicz added a commit to pbanaszkiewicz/amy that referenced this issue Nov 6, 2022
@pbanaszkiewicz
[carpentries#2273] Update procedures.md with changelog changes
27d9a9d
pbanaszkiewicz added a commit that referenced this issue Nov 6, 2022
@pbanaszkiewicz
Merge pull request #2276 from pbanaszkiewicz/feature/2268-docs-update…
bb3f18e 
…-applications

[#2268][#2273] Documentation: update applications documentation, update releases
@pbanaszkiewicz pbanaszkiewicz added this to the v4.0.5 milestone Nov 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@pbanaszkiewicz pbanaszkiewicz

Labels
component: documentation type: new feature
Projects
None yet
Milestone
v4.0.5
Development

Successfully merging a pull request may close this issue.

[#2268][#2273] Documentation: update applications documentation, update releases pbanaszkiewicz/amy
1 participant
@pbanaszkiewicz