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

Revise development release checklist document for new processes #120

Closed
jathanism opened this issue Mar 8, 2021 · 0 comments · Fixed by #198
Closed

Revise development release checklist document for new processes #120

jathanism opened this issue Mar 8, 2021 · 0 comments · Fixed by #198
Assignees
Labels
type: documentation Improvements or additions to documentation
Milestone

Comments

@jathanism
Copy link
Contributor

Proposed Changes

Revise the "release checklist" at docs/development/release-checklist.md to account for the following (at a minimum):

  • We are using poetry and pyproject.toml now to manage packaging and dependencies
  • As a result, updating the version is done using poetry version {new_version}
  • Updating dependent libraries and the poetry.lock where versions are pinned is done using poetry update
  • The steps taken to follow the "git flow-like" pattern we're using
    • Cutting a develop-{version} branch from develop to update release notes, bump version, etc.
    • Submitting a PR from develop-{version} back into develop (1 approval)
    • Submitting a PR from develop into main (2 approvals required)
  • The new release must published to PyPI using poetry publish

Justification

Since we've changed the way Nautobot is packaged, deployed, and configured compared to its ancestor NetBox, we need to revise the release checklist for the new world.

@jathanism jathanism added this to the v1.0.0 milestone Mar 8, 2021
@jathanism jathanism added type: documentation Improvements or additions to documentation status: current labels Mar 8, 2021
@jathanism jathanism self-assigned this Mar 15, 2021
@jathanism jathanism added this to In progress in Release v1.0.0 Mar 24, 2021
jathanism added a commit to jathanism/nautobot that referenced this issue Mar 25, 2021
- In: `pyproject.toml;poetry.lock`; Out: `[base_]requirements.txt`
- Removed reference to updating development version
- Explaining use of `poetry update` for updating requirements
- Explaining use of `poetry version` to update... version
- Explaining use of `poetry build|publish` for publishing to PyPI
Release v1.0.0 automation moved this from In progress to Done Mar 26, 2021
jathanism added a commit that referenced this issue Mar 26, 2021
* Fix #120 - Revise development release checklist

- In: `pyproject.toml;poetry.lock`; Out: `[base_]requirements.txt`
- Revised reference to updating development version
- Explaining use of `poetry update` for updating requirements
- Explaining use of `poetry version` to update... version
- Explaining use of `poetry build|publish` for publishing to PyPI
- Replace "manually perform a new install" with "verify and revise install docs"

Co-authored-by: Glenn Matthews <glenn.matthews@networktocode.com>
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 25, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
type: documentation Improvements or additions to documentation
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

1 participant