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

[Enabler][692] Add a command that checks the changelog into ac and create a GitHub action #1422

Open
wants to merge 16 commits into
base: dev
Choose a base branch
from
Open

[Enabler][692] Add a command that checks the changelog into ac and create a GitHub action #1422

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
b25f4a9
Create 'ac-ansible-test.yml'
IsaacVRey Mar 20, 2024
78491b8
Test
IsaacVRey Mar 20, 2024
4245d36
Add check changelog command to the ac tools
IsaacVRey Mar 20, 2024
4047bb2
Create ac-check-changelog.yml
IsaacVRey Mar 20, 2024
ad355ba
Fix
IsaacVRey Mar 20, 2024
b314a87
Fix
IsaacVRey Mar 20, 2024
a709205
Change ac command
IsaacVRey Mar 20, 2024
65d0e6c
Change ac command
IsaacVRey Mar 20, 2024
b221687
Change ac command
IsaacVRey Mar 20, 2024
f8de9ed
Change ac command
IsaacVRey Mar 20, 2024
e0ab064
Delete test changelog
IsaacVRey Mar 20, 2024
12673db
Delete some blank spaces
IsaacVRey Apr 5, 2024
492b10a
Merge branch 'dev' into enabler/692/add-ac-check-changelog
IsaacVRey Apr 5, 2024
b2c6022
Add paths-ignore
IsaacVRey Apr 11, 2024
e3ea200
Update ac-check-changelog.yml
IsaacVRey Apr 11, 2024
52429bf
Merge branch 'dev' into enabler/692/add-ac-check-changelog
AndreMarcel99 Jun 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 62 additions & 0 deletions .github/workflows/ac-check-changelog.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
name: AC Check Changelog

on:
pull_request:
branches:
- dev
- staging*
paths-ignore:
- '**.tar.gz'
- 'pycache/**'
- '.ansible-lint'
- 'cache/**'
- '.DS_Store'
- '.git/**'
- '.github/**'
- '.gitignore'
- '.python-version'
- '.pytest_cache/**'
- '.vscode/**'
- 'Jenkinsfile'
- 'ac'
- 'ansible.cfg'
- 'collections/**'
- 'docs/**'
- 'scripts/**'
- 'test_config.yml'
- 'tests/*.ini'
- 'tests/*.py'
- 'tests/.pytest_cache'
- 'tests/pycache'
- 'tests/functional'
- 'tests/helpers'
- 'tests/requirements.txt'
- 'tests/unit'
- 'tests/sanity/ignore-*'
- 'venv*'

IsaacVRey marked this conversation as resolved.
Show resolved Hide resolved
jobs:
check-changelog:
runs-on: ubuntu-latest
env:
PR_BASE: ${{ github.event.pull_request.base.ref }}
PR_HEAD: ${{ github.event.pull_request.head.ref }}
steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: 3.11

- name: Set up venv
run: |
python -m pip install --upgrade pip
pip install virtualenv
mkdir venv
virtualenv venv/venv-2.16

- name: Run ac-check-changelog
run: |
./ac --ac-check-changelog --base "$PR_BASE" --head origin/"$PR_HEAD"
71 changes: 55 additions & 16 deletions ac
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -270,18 +270,6 @@ ac_build(){
}

# ------------------------------------------------------------------------------
# Run galaxy importer on collection.
# ------------------------------------------------------------------------------
#->ac-galaxy-importer:
## Build current branch and run galaxy importer on collection.
## Usage: ac [--ac-galaxy-importer]
## Example:
## $ ac --ac-galaxy-importer
ac_galaxy_importer(){
message "Running Galaxy Importer"
. $VENV_BIN/activate && collection_name=$($VENV_BIN/ansible-galaxy collection build --force | awk -F/ '{print $NF}') && python -m galaxy_importer.main $collection_name
}

# Run a changelog lint locally
# ------------------------------------------------------------------------------
#->ac-changelog:
Expand All @@ -307,6 +295,38 @@ ac_changelog(){
. $VENV_BIN/activate && antsibull-changelog "${option_command}"
}

# Check for new files in the changelog.
# Comparing it to another branch.
# ------------------------------------------------------------------------------
#->ac-check-changelog:
## Check for new files in the changelog.
## Usage: ac [--ac-check-changelog <base> <head>]
## <base> - Branch to compare with
## <head> - This branch
## Example:
## $ ac-check-changelog --base dev --head test
ac_check_changelog(){
option_base=$1
option_head=$2
if [ ! "$option_base" ]; then
option_base="dev"
fi
message "Check for new files in the changelog."
. $VENV_BIN/activate && git fetch && git checkout origin/"$option_base" && cd changelogs/fragments/ && LS_BASE="$(ls)" && cd .. && cd .. && git checkout "$option_head" ./changelogs/fragments/ && cd changelogs/fragments/ && LS_ALL="$(ls)" && git checkout "$option_head" && [ "${#LS_ALL}" -gt "${#LS_BASE}" ] || (echo "No new changelog file was found" && return 1) #echo $VAR && [ "$VAR" != "No new changelog file was found" ] ||
}

# Run galaxy importer on collection.
# ------------------------------------------------------------------------------
#->ac-galaxy-importer:
## Build current branch and run galaxy importer on collection.
## Usage: ac [--ac-galaxy-importer]
## Example:
## $ ac --ac-galaxy-importer
ac_galaxy_importer(){
message "Running Galaxy Importer"
. $VENV_BIN/activate && collection_name=$($VENV_BIN/ansible-galaxy collection build --force | awk -F/ '{print $NF}') && python -m galaxy_importer.main $collection_name
}

# ------------------------------------------------------------------------------
# Install an ibm_zos_core collection from galaxy (or how you have ansible.cfg configured)
# ------------------------------------------------------------------------------
Expand Down Expand Up @@ -757,6 +777,13 @@ while true; do
ensure_managed_venv_exists $1
option_submitted="--ac-build"
;;
--ac-check-changelog) # Command
ensure_managed_venv_exists $1
option_submitted="--ac-check-changelog"
;;
--ac-galaxy-importer) # Command
ensure_managed_venv_exists $1
option_submitted="--ac-galaxy-importer"
--ac-galaxy-importer) # Command
ensure_managed_venv_exists $1
option_submitted="--ac-galaxy-importer"
Expand Down Expand Up @@ -832,7 +859,12 @@ while true; do
ensure_managed_venv_exists $1
option_submitted="--venv-stop"
;;
--command|--command=?*) # option
--base|--base=?*) # option
base=`option_processor $1 $2`
option_sanitize $base
shift
;;
--command|--command=?*) # option
command=`option_processor $1 $2`
option_sanitize $command
shift
Expand All @@ -847,7 +879,12 @@ while true; do
option_sanitize $file
shift
;;
--host|--host=?*) # option
--head|--head=?*) # option
head=`option_processor $1 $2`
option_sanitize $head
shift
;;
--host|--host=?*) # option
host=`option_processor $1 $2`
option_sanitize $host
shift
Expand Down Expand Up @@ -926,10 +963,12 @@ if [ "$option_submitted" ] && [ "$option_submitted" = "--ac-bandit" ] ; then
ac_bandit $level
elif [ "$option_submitted" ] && [ "$option_submitted" = "--ac-build" ] ; then
ac_build
elif [ "$option_submitted" ] && [ "$option_submitted" = "--ac-galaxy-importer" ] ; then
ac_galaxy_importer
elif [ "$option_submitted" ] && [ "$option_submitted" = "--ac-changelog" ] ; then
ac_changelog $command
elif [ "$option_submitted" ] && [ "$option_submitted" = "--ac-check-changelog" ] ; then
ac_check_changelog $base $head
elif [ "$option_submitted" ] && [ "$option_submitted" = "--ac-galaxy-importer" ] ; then
ac_galaxy_importer
elif [ "$option_submitted" ] && [ "$option_submitted" = "--ac-module-doc" ] ; then
ac_module_doc
elif [ "$option_submitted" ] && [ "$option_submitted" = "--ac-install" ] ; then
Expand Down