Prep repo for releases - Githubissues

cyberark / conjur-api-python

Python client for the CyberArk Conjur API

Apache License 2.0

8 stars 3 forks source link

Prep repo for releases #40

Closed gl-johnson closed 1 year ago

gl-johnson commented 1 year ago

Desired Outcome

Prepare conjur-api-python for releases as part of the OSS suite

Implemented Changes

Add automated releasing to pipeline
Add changelog validation and versioning
Reset version to v0.1.0 for release
Validated release pushed to PyPI and accessible from python projects / pip install

Automated release behavior:

Build - regular branch push or PR

Validation
Unit tests
Integration tests

Release - PR merged into main

Validation
Unit tests
Integration tests
Creates git pre-release with release notes up to that point
Creates git tag with build number (i.e. 0.0.5-12)

Promote - manual via Jenkins when releasing

Updates conjur_api/__init.py__ to match release version
Publishes project to PyPI
Publishes the git pre-release

Definition of Done

At least 1 todo must be completed in the sections below for the PR to be merged.

Changelog

[ ] The CHANGELOG has been updated, or
[x] This PR does not include user-facing changes and doesn't require a CHANGELOG update

Test coverage

[ ] This PR includes new unit and integration tests to go with the code changes, or
[x] The changes in this PR do not require tests

Documentation

[ ] Docs (e.g. READMEs) were updated in this PR
[ ] A follow-up issue to update official docs has been filed here: [insert issue ID]
[x] This PR does not require updating any documentation

Behavior

[ ] This PR changes product behavior and has been reviewed by a PO, or
[ ] These changes are part of a larger initiative that will be reviewed later, or
[x] No behavior was changed with this PR

Security

[ ] Security architect has reviewed the changes in this PR,
[ ] These changes are part of a larger initiative with a separate security review, or
[x] There are no security aspects to these changes