Project

Profile

Help

Task #4875

Adopt aiohttp release notes process for pulpcore and pulpcore-plugin

Added by bmbouter 8 months ago. Updated about 1 month ago.

Status:
CLOSED - CURRENTRELEASE
Priority:
Normal
Assignee:
Category:
-
Sprint/Milestone:
Start date:
Due date:
% Done:

0%

Platform Release:
Blocks Release:
Backwards Incompatible:
No
Groomed:
Yes
Sprint Candidate:
Yes
Tags:
QA Contact:
Complexity:
Smash Test:
Verified:
No
Verification Required:
No
Sprint:
Sprint 53

Description

To accomplish this we would:

1. Update the contributor notes for pulpcore to outline the requirement

2. Update the contributor notes for pulpcore-plugin to outline the requirement

3. Update 'check_commit_message.py' script to look for a file in CHANGES directory of pulpcore.

4. Update 'check_commit_message.py' script to look for a file in CHANGES directory of pulpcore-plugin.

5. Update the https://pulp.plan.io/projects/pulp/wiki/Pulp3_Release_Guide to incorporate step on generating the release notes for pulpcore

6. Update the https://pulp.plan.io/projects/pulp/wiki/Pulp3_Release_Guide to incorporate step on generating the release notes for pulpcore-plugin

Associated revisions

Revision b75eb1ec View on GitHub
Added by bmbouter 8 months ago

Add new changelog process

- Adds a changelog update section to the docs
- creates the base CHANGES.rst file
- creates the CHANGES directory for news updates and indicates to git to
store the dir even if empty with a .gitignore.
- adds a release note for this change
- adds a docs section that loads the CHANGES.rst file on the website

https://pulp.plan.io/issues/4875
re #4875

Revision 9d661db2 View on GitHub
Added by bmbouter 8 months ago

Add new changelog process

- Adds a changelog update section to the docs
- creates the base CHANGES.rst file
- creates the CHANGES directory for news updates and indicates to git to
store the dir even if empty with a .gitignore.
- adds a docs section that loads the CHANGES.rst file on the website

https://pulp.plan.io/issues/4875
re #4875

Revision 9bf8a4f9 View on GitHub
Added by bmbouter 8 months ago

Have version use correct replacement string

This needs to use the setup.py name to work correctly.

https://pulp.plan.io/issues/4875
re #4875

Revision d7973473 View on GitHub
Added by bmbouter 8 months ago

Remove release note vestige

This prevents correct building of the sphinx project.

https://pulp.plan.io/issues/4875
re #4875

Revision b0473510 View on GitHub
Added by bmbouter 8 months ago

Consolidate release notes

There was a release notes section and a changelog section, and this
consolidates them into one. The existing release notes are moved into
the HISTORY.rst file.

An entry in CHANGES was made for an existing removal release note that
was there.

https://pulp.plan.io/issues/4875
re #4875

Revision 9effeb28 View on GitHub
Added by bmbouter 8 months ago

Add new changelog process

- Fix broken sphinx docs site
- Adds a changelog update section to the docs
- creates the base CHANGES.rst file
- creates the CHANGES directory for news updates and indicates to git to
store the dir even if empty with a .gitignore.
- adds a release note for this change
- adds a docs section that loads the CHANGES.rst file on the website

https://pulp.plan.io/issues/4875
re #4875

Revision 0572569e View on GitHub
Added by bmbouter 8 months ago

Explicitly specify version in version

Since RTD doesn't actually install pulp-certguard it can't use this type
of lookup. I'm hardcoding the version now, and we can use bumpversion
later to auto-manage this.

https://pulp.plan.io/issues/4875
re #4875

Revision 813fbd03 View on GitHub
Added by bmbouter 8 months ago

Change heading of changelog docs

This heading wasn't being clearly shown.

https://pulp.plan.io/issues/4875
re #4875

Revision 558df6d3 View on GitHub
Added by bmbouter 8 months ago

Add new changelog process

- Adds a changelog update section to the docs
- creates the base CHANGES.rst file
- creates the CHANGES directory for news updates and indicates to git to
store the dir even if empty with a .gitignore.
- adds a release note for this change
- adds a docs section that loads the CHANGES.rst file on the website

https://pulp.plan.io/issues/4875
re #4875

Revision 7dd70265 View on GitHub
Added by bmbouter 8 months ago

Add new changelog process

- Adds a changelog update section to the docs
- creates the base CHANGES.rst file
- creates the CHANGES directory for news updates and indicates to git to
store the dir even if empty with a .gitignore.
- adds a release note for this change
- adds a docs section that loads the CHANGES.rst file on the website
- updates the version to 0.1.0b1
- Adds a contributing guide

https://pulp.plan.io/issues/4875
re #4875

Revision feb3da2e View on GitHub
Added by bmbouter 8 months ago

Add new changelog process

- Adds a changelog update section to the docs
- creates the base CHANGES.rst file
- creates the CHANGES directory for news updates and indicates to git to
store the dir even if empty with a .gitignore.
- adds a release note for this change
- adds a docs section that loads the CHANGES.rst file on the website
- Adds a contributing guide

https://pulp.plan.io/issues/4875
re #4875

Revision 2a6d70c0 View on GitHub
Added by bmbouter 8 months ago

Add new changelog process

- Adds a changelog update section to the docs
- creates the base CHANGES.rst file
- creates the CHANGES directory for news updates and indicates to git to
store the dir even if empty with a .gitignore.
- adds a release note for this change
- adds a docs section that loads the CHANGES.rst file on the website
- Adds a contributing guide

https://pulp.plan.io/issues/4875
re #4875

Revision 2a6d70c0 View on GitHub
Added by bmbouter 8 months ago

Add new changelog process

- Adds a changelog update section to the docs
- creates the base CHANGES.rst file
- creates the CHANGES directory for news updates and indicates to git to
store the dir even if empty with a .gitignore.
- adds a release note for this change
- adds a docs section that loads the CHANGES.rst file on the website
- Adds a contributing guide

https://pulp.plan.io/issues/4875
re #4875

Revision 2a6d70c0 View on GitHub
Added by Brian Bouterse 8 months ago

Add new changelog process

- Adds a changelog update section to the docs
- creates the base CHANGES.rst file
- creates the CHANGES directory for news updates and indicates to git to
store the dir even if empty with a .gitignore.
- adds a release note for this change
- adds a docs section that loads the CHANGES.rst file on the website
- Adds a contributing guide

https://pulp.plan.io/issues/4875
re #4875

Revision 2a6d70c0 View on GitHub
Added by Brian Bouterse 8 months ago

Add new changelog process

- Adds a changelog update section to the docs
- creates the base CHANGES.rst file
- creates the CHANGES directory for news updates and indicates to git to
store the dir even if empty with a .gitignore.
- adds a release note for this change
- adds a docs section that loads the CHANGES.rst file on the website
- Adds a contributing guide

https://pulp.plan.io/issues/4875
re #4875

Revision 760c5125 View on GitHub
Added by bmbouter 8 months ago

Fix version to use correct package name

https://pulp.plan.io/issues/4875
re #4875

Revision 760c5125 View on GitHub
Added by bmbouter 8 months ago

Fix version to use correct package name

https://pulp.plan.io/issues/4875
re #4875

Revision 760c5125 View on GitHub
Added by Brian Bouterse 8 months ago

Fix version to use correct package name

https://pulp.plan.io/issues/4875
re #4875

Revision 760c5125 View on GitHub
Added by Brian Bouterse 8 months ago

Fix version to use correct package name

https://pulp.plan.io/issues/4875
re #4875

Revision 502b4576 View on GitHub
Added by Brian Bouterse 8 months ago

Another version fix attempt

https://pulp.plan.io/issues/4875
re #4875

Revision 502b4576 View on GitHub
Added by Brian Bouterse 8 months ago

Another version fix attempt

https://pulp.plan.io/issues/4875
re #4875

Revision 90cfb6c8 View on GitHub
Added by bmbouter 8 months ago

Add new changelog process

- Adds a changelog update section to the docs
- creates the base CHANGES.rst file
- creates the CHANGES directory for news updates and indicates to git to
store the dir even if empty with a .gitignore.
- adds a release note for this change
- adds a docs section that loads the CHANGES.rst file on the website
- Adds a contributing guide
- mMoves existing release notes to HISTORY.rst

https://pulp.plan.io/issues/4875
re #4875

Revision 31001153 View on GitHub
Added by bmbouter 8 months ago

Fix version string

This bit was missing. This is working in pulp-certguard on RTD.

https://pulp.plan.io/issues/4875
re #4875

Revision 31001153 View on GitHub
Added by bmbouter 8 months ago

Fix version string

This bit was missing. This is working in pulp-certguard on RTD.

https://pulp.plan.io/issues/4875
re #4875

Revision 31001153 View on GitHub
Added by Brian Bouterse 8 months ago

Fix version string

This bit was missing. This is working in pulp-certguard on RTD.

https://pulp.plan.io/issues/4875
re #4875

Revision 31001153 View on GitHub
Added by Brian Bouterse 8 months ago

Fix version string

This bit was missing. This is working in pulp-certguard on RTD.

https://pulp.plan.io/issues/4875
re #4875

Revision 7e27bc8c View on GitHub
Added by bmbouter 8 months ago

Fix sphinx conf.py version

This now uses the pulp_file.__version__ which is now a string so it can
be inspected without the package needing to be installed.

https://pulp.plan.io/issues/4875
re #4875

Revision ecc3fc2e View on GitHub
Added by bmbouter 8 months ago

Fix sphinx conf.py version

This now uses the pulp_ansible.__version__ which is now a string so
it can be inspected without the package needing to be installed.

https://pulp.plan.io/issues/4875
re #4875

Revision 81b017c4 View on GitHub
Added by bmbouter 8 months ago

Fix verison to be string

The `pulpcore.__version__` should be a string so you don't have to have
the package installed to know its version.

Also this change allows you to build the docs (with the correct version)
without having pulpcore itself installed. This allows docs building in
more places.

https://pulp.plan.io/issues/4875
re #4875

Revision 34f9ff09 View on GitHub
Added by bmbouter 8 months ago

Fix version to be a string

Without this commit you would have to have the plugin installed to check
its version. This moves more towards standard Python packaging formats.

Also I moved the CONTRIBUTING.rst text to the top level and additionally
use it in the Sphinx site for more visibility

Also this updates the base version to a more reasonable version string:
0.1.0a1

https://pulp.plan.io/issues/4875
re #4875

History

#1 Updated by dkliban@redhat.com 8 months ago

  • Description updated (diff)

#2 Updated by dkliban@redhat.com 8 months ago

  • Groomed changed from No to Yes
  • Sprint Candidate changed from No to Yes

#3 Updated by bmbouter 8 months ago

  • Status changed from NEW to ASSIGNED
  • Assignee set to bmbouter

#4 Updated by bmbouter 8 months ago

  • Status changed from ASSIGNED to POST

#5 Updated by bmbouter 8 months ago

  • Status changed from POST to MODIFIED
  • Sprint set to Sprint 53

all done!

#6 Updated by bmbouter about 1 month ago

  • Sprint/Milestone set to 3.0.0

#7 Updated by bmbouter about 1 month ago

  • Status changed from MODIFIED to CLOSED - CURRENTRELEASE

Please register to edit this issue

Also available in: Atom PDF