joeu128/testgitworkflow repository overview

⁠Git Workflows

⁠Prerequisites

• Create a Secret⁠ PAT with your Personal Access Token
• with Docker
  • Create a Secret⁠ DOCKER_SECRET
  • Create a Secret⁠ DOCKER_USERNAME

⁠Adjusting Workflow-Files

• configure Pathes in labeler.yml⁠, delete this file and workflows/labeler.yml⁠ if not needed
• configure updateDocInREADME.yml⁠, delete it if not needed
• configure Bump Version for Versioned Projects
  • configure Step Bump version in workflows/bump-version/action.yml⁠
• configure Bump Version for Un-Versioned Projects
  • delete workflows/force-bump-version.yml⁠
  • delete Folder workflows/bump-version⁠
  • remove input bump-version and Steps bump-version and bumpVars in workflows/draft-release.yml⁠
  • remove input steps.bumpVars.outputs.bumpHint in body of Step createPR in workflows/draft-release.yml⁠
  • remove input bump-version and Step bump-version in workflows/publish-release.yml⁠
  • adjust output lastCommitSha by removing steps.bump-version.outputs.commitSha || in workflows/publish-release.yml⁠
• wihtout Docker
  • use workflows/draft-release.yml⁠
  • use workflows/publish-release.yml⁠
  • delete workflows/push-docker.yml⁠
  • delete workflows/update-docker-description.yml⁠
• with Docker
  • use workflows/draft-release-with-docker.yml⁠ and rename it to draft-release.yml
  • use workflows/publish-release-with-docker.yml⁠
  • configure platforms for Steps Set up QEMU and Build and push image in workflows/push-docker.yml⁠
  • configure workflows/update-docker-description.yml⁠

⁠Adjusting renovate-config

• add label, gitIgnoredAuthors and github-Group

  "gitIgnoredAuthors": [
    "41898282+github-actions[bot]@users.noreply.github.com"
  ],
  "packageRules": [
    {
      "matchFileNames": [
        ".github/**"
      ],
      "groupName": "github-actions"
    }
  ],
  "labels": [
    "renovate"
  ]
  

  Copy

⁠validate reconfiguration

• install nodeJs via nvm⁠

  curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash
  nvm list-remote
  ...
          v22.8.0
  ->      v22.9.0
  nvm install v22.9.0
  

  Copy
• install renovate and validate config⁠

  npm i -g renovate
  renovate-config-validator --strict
  or 
  npx --yes --package renovate -- renovate-config-validator --strict
  

  Copy

⁠ShowCases

⁠updateDocInREADME.yml in Action

• The following Content comes from File updateDocInREADME.yml

• Add another List-Item into Replaced Content to fix Alignment

  This Content in Readme should be the same as in File "MarkdownDocContentForReadme.md"
    
  

  Copy
  It will only be replaced if this File is changed and merged via PR
• Just another List-Item from Content-File

• Generated List-Item with quotted String

  ./DOIT.sh -h
  Doc for Shell-Doit
    -d  --debug       Debug Script'
    -f  --fancy       Fancy Feature'
  

  Copy

• Initially this Snippet must be committed

  <!-- searchstring_start -->
  
  Initially here has to be any Char, also a "new Line" will be found
  
  <!-- searchstring_end -->
  

  Copy

⁠Tipps

⁠initalize a fresh CHANGELOG.md

• add a compare Link

  [Unreleased]: https://github.com/joe128/<repo>/compare/<firstCommit>...HEAD
  

  Copy
• or if there are problems Could not infer the compare link

  docker pull rcmachado/changelog
  alias changelogtool='docker run --rm -it -v "$(pwd)":/src docker.io/rcmachado/changelog:latest'
  changelogtool -f /src/CHANGELOG.md init -c https://github.com/joe128/<repo>/compare/<firstCommit>...HEAD -o /src/CHANGELOG.md
  

  Copy

⁠use local python-package

• add +local to your version
• create local package poetry build
• pip install with full-path python3 -m pip install /home/../src/<project>/dist/project-1.0.0+local-py3-none-any.whl
• update your dependency to project-1.0.0+local

⁠enable Github-Action - Debug

• <User/Repo>/settings/variables/actions⁠
• Add a Repository Variable ACTIONS_RUNNER_DEBUG with value true for the Runner
• Add a Repository Variable ACTIONS_STEP_DEBUG with value true for Steps