Skip to content

Latest commit

 

History

History
executable file
·
402 lines (240 loc) · 10.5 KB

CHANGELOG.md

File metadata and controls

executable file
·
402 lines (240 loc) · 10.5 KB

Changelog

All notable changes to this project will be documented in this file.

This project adheres to Semantic Versioning.

1.13.1 (2024-09-24)

Changes

Fix Bug where the open PR Workflows would detect as "latest" not the tag with highest Semantic Version Precedence, but an '-rc' tag.

Fix

  • ensure PR Changes sections, renders list of commits from feature/release branches only

1.13.0 (2024-09-24)

Changes

Feature

  • better PR Title and Body contents, with automatically parsed commit history, for 'PR to main' Workflow
  • crash and report error if user is on release branch when opening PR to release
  • better PR Title and Body contents, with automatically parsed commit history, for PR to release

Fix

  • properly pass dynamic flag in gh CLI based on backword-compatibility User Input
  • add permission for registering new label in available repository PR Labels
  • checkout main before Tag on main

1.12.1-dev1 (2024-09-21)

Changes

Docs

  • add How-to "setup Automatic Semantic Tag on Main' Guide

1.12.1-dev (2024-09-19)

Changes

Docs

  • add 'Setup Automatic Clean-Up' How-to Guide

CI

  • automatically delete git ops tags, after they served their purpose

1.12.0 (2024-09-19)

Changes

Add new Reusable Workflow for doing Clean-up, during the final phase of release-me Git Ops Process.

Feature

  • delete Git Ops events related tags, on-demand with Reusable Workflow

Docs

  • add API Reference Pages for 'Tag Prod' and 'Clean-up Tags' Reusable Workflows
  • fix auto-prod-* event trigger shell command

CI

| * 48376c9 ci: fix gitops _tag_prod Workflow

Other

  • fix Automatic mkdocs Side-Navigation-update and API Gen script

1.11.1 (2024-09-19)

Changes

Docs

  • fix auto-prod-* event trigger shell command

CI

  • automatically push test branch before Automated CI Tests

1.11.0 (2024-09-18)

Changes

Feature

  • write release -> main PR comment mentioning auto-merge commit message

CI

  • merge 'release' into 'test' before RC tag (and auto-merge PR main enable)
  • update labeler so that it groups Git Ops feature changes under 'rw_gitops' tag

1.10.0 (2024-09-18)

Changes

Feature

  • report the Merge (on main) Commit Message in GH STEP SUMMARY

Docs

  • include Next Steps, for Release Me Run Guide
  • improve Release Me Run Guide UX, by using icons
  • improve UX with dynamically assisted Changelog update
  • improve UX, with dynamically assisted Release Sem Ver Deriviation

1.9.0 (2024-09-17)

Changes

Feature

  • Tag main branch during Release Me Git Ops Process, when auto-deploy labeled PR merges on main, from release br
  • use same -dev tag if pushed in auto-prod-

1.8.1-dev1 (2024-09-17)

Changes

CI

  • fix conditional logic that dynamically selects Job Matrix

1.8.1-dev (2024-09-17)

Changes

CI

  • do not run Release Test Cases, on v* tags pushed to main

Git Ops

  • call go-auto-merge-main.yml, to handle 'auto-prod-*' tag events

1.8.0 (2024-09-17)

Changes

Feature

  • register auto-deploy label during Auto Prod Workflow, only if missing from Repo PR Labels

1.7.2 (2024-09-17)

Changes

Feature

  • convert -dev tags into -rc when running Auto Prod Workflow

Fix

  • correctly name tag on main and improve Auto Prod

Docs

  • mention that Release Me Phase 2 creates an RC Tag on release branch

1.7.1 (2024-09-16)

Changes

fix
  • expect Contents Write permission in release-me PAT
  • console logging message when no inputs.backwords_compatibility is given
docs
  • improve Git Ops Release Me Run How-to Guide
  • render text Tooltip when hovering on CI/CD introduction text
  • enable abbr markdown extension in mkdocs build

1.7.1-dev1 (2024-09-15)

Adding How-to Guide for Running release-me Git Ops Process.

Changes

docs
  • write user-friendly content for Git Ops Guides landing page
  • add page for 'Run release-me Git Ops Process' How-to Guide
  • improve Test Suite Development Flow Chart

1.7.1-dev (2024-09-13)

Adding Documentation Content for Git Ops Process

  • How-to Guides
    • Setup Automatic Acceptance to protect your main branch
    • Setup Manual Acceptance to add manual intervention as merge requirement

Changes

docs
  • add Guide Page for 'Protecting Branch' with Auto QA
  • update README.md to match CI/CD and Git Ops features
  • add 'Setup Manual Acceptance' How-to Guide, of 'release-me' Git Ops Process

1.7.0 (2024-08-03)

Phase 2 of release-me Git Ops Process

  • Offers Reusable Workflow
  • Offers How-to setup Guide

Changes

feature
  • add .github/workflows/go-auto-merge-main.yml Reusable Workflow
  • allow declaring backwords-compatibility (or not) in `release-me' Phase 2
docs
  • add Ref Page, Topics and Guide in Docs Site
  • improve Git Ops Ref Pages

1.6.2 (2024-07-30)

Document Git Ops and release-me Git Ops Process in Docs Website.

  • Add Guide Page for How-to setup a new release-me Git Ops Process

1.6.0 (2024-07-29)

Support for **Git Ops 'release-me' Phase 1 Process, through 2 Reusable Workflows.

Changes

feature
  • implement pr to release and main as building blocks for Git Ops
  • enable 'release' PR auto merge, in go-pr-to-release
ci
  • dedicate 2 _gitops-pr-to-{release,main}.yml Workflows for release-me Git Ops Process phase 1
  • run release-me automated Test Cases from Test Suite, in Job Matrix
docs
  • update automatic ref pages
  • docs: update site with Git Ops Ref Pages for release and main PRs

1.5.0

New Single Status Workflow for Git Ops,

Changes

feature
  • improve step.name content
  • add 'Single Status' Workflow for Git Ops
build
  • add docker and compose files for docs_dev server
git ops
  • pass in PAT with PR r/w and Actions r/w; change logic of Pipe Config based on Gitops Signal
docs
  • add all current User Facing Worklflows in Site Navigation
  • redesign README.md with better sections and collapsible content
  • add 'topic' about go-single-status.yml workflow idea
  • automatically generate API Ref Pages and Add them to Site Navigation, if missing
  • do not generate Ref Pages during Read The Docs Builds

1.4.0 (2024-03-15)

2 New Reusable Workflows:

Changes

feature
  • allow passing custom GH_TOKEN for gh CLI
  • add GH Release Reusable Workflow with requred input 'tag'
  • close PR if already open, and then open new one, for GitOps Pr to Boarding Workflow
  • add Reusable Workflow for opening PR 'User Branch' --> 'Boarding'

1.3.0 (2024-02-12)

Changes

feature
  • allow overriding the command to run for Docs Build Reusable Workflow
  • add Docs Build Workflow, that builds the Documentation Pages, with 4 Policies
  • add sensible defaults to Workflow Inputs & improve output Console messages to CI UI
  • allow all combinations of edit, sdist, wheel
  • do NOT require Input value for PEP 440 Version
  • do NOT require Input Distro Name
  • Upload Artifacts tar.gz & whl
  • add Test Build Workflow, that Builds n Test Python, with 4 Policies
  • add Visualize Code Workflow, that parses Module Imports to create SVG Graph
fix
  • pin dependencies and use separate envs when both sdist and wheel builds
  • use extra quotes to achieve shell glob expansion
documentation
  • add Pages for 'Build Guide' and Refs for Build and Docs
  • document new Automated Tests implemented on CI, as Github Caller Workflows
  • add Doc Refs for 'Docs', and Doc Refs + Guide for 'Python Build'
  • catalog the Automated Tests dedicated for Testing the Code Viz Workflow
  • catalog new Module Imports, aka Pydeps, Workflow, in the Feature List of README.md
  • add Reference Page for Module Imports, aka Pydeps, Workflow, in Docs Website
  • add Reference Page for Module Imports, aka Pydeps, Workflow in Docs Website
refactor
  • reorder Inputs key values
  • fix workflow name spelling
  • clean Workflow code
  • add more Console Ouput to assist in debugging
ci
  • do not trigger on 'dev' branch, and add trigger for 'v*' and 'run-ci' tags

1.2.0 (2023-12-19)

Changes

features

  • add new Static Code Analysis Workflow, leveraging tox, as front-end

docs

  • website: add Ref Page for Static Code Analysis Reusable Workflow

1.1.4 (2023-12-08)

We add Continuous Integration, implemented in Github Actions.
So, on push to main, a Workflow triggers, which runs the cicd-test Test Suite (maintained in separate repo), against our Automated Workflows, in various Scenarios.

The Test Suite, includes Python Tests, which are responsible for triggering dedicated Test Workflows of cicd-test, in various Scenarios and Configurations, and automatically make Assertions.

Changes

docs

  • rtd: generate Reference Pages from workflow yaml files on CI
  • mkdocs: new 'References' left-side Section (lss), and nest 'Test Suite' under new 'Topics' lss
  • reference-pages: add reference pages for docker.yml and pypi_env.yml reusable workflows, in Website
  • readme: add ci code badges !

ci

  • add Job, which runs the CPU-distributed tests, which trigger our Automate Workflows, in diverse Test Scenarios

1.1.3 (2023-12-04)

Changes

docs

1.1.2 (2023-12-04)

Changes

docs

1.1.1 (2023-12-04)

New Documentation Website for Automated Workflows!

Changes

docs

  • add the 'GNU Affero General Public License v3.0' LICENSE
  • update README with URL links to CI, Docs, and Source Code & Code Badges

1.1.0 (2023-11-13)

Changes

features

allow controlling the --skip-existing twine upload flag, from Caller Job, when calling the PyPI Resuable Workflow

1.0.0 (2023-11-13)

CI/CD Pipelines for Docker and PyPI. implemented as Github Actions Resuable Workflows

  • Docker: Build Docker image and Push to Dockerhub.
  • PyPI: Upload Python distribution to PyPI