gha-utils 4.0.1__py3-none-any.whl

gha_utils-4.0.1.dist-info/METADATA

@@ -0,0 +1,625 @@
+Metadata-Version: 2.1
+Name: gha-utils
+Version: 4.0.1
+Summary: ⚙️ CLI helpers for GitHub Actions + reuseable workflows
+Author-email: Kevin Deldycke <kevin@deldycke.com>
+License: GNU GENERAL PUBLIC LICENSE
+                               Version 2, June 1991
+        
+         Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+         51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+         Everyone is permitted to copy and distribute verbatim copies
+         of this license document, but changing it is not allowed.
+        
+                                    Preamble
+        
+          The licenses for most software are designed to take away your
+        freedom to share and change it.  By contrast, the GNU General Public
+        License is intended to guarantee your freedom to share and change free
+        software--to make sure the software is free for all its users.  This
+        General Public License applies to most of the Free Software
+        Foundation's software and to any other program whose authors commit to
+        using it.  (Some other Free Software Foundation software is covered by
+        the GNU Lesser General Public License instead.)  You can apply it to
+        your programs, too.
+        
+          When we speak of free software, we are referring to freedom, not
+        price.  Our General Public Licenses are designed to make sure that you
+        have the freedom to distribute copies of free software (and charge for
+        this service if you wish), that you receive source code or can get it
+        if you want it, that you can change the software or use pieces of it
+        in new free programs; and that you know you can do these things.
+        
+          To protect your rights, we need to make restrictions that forbid
+        anyone to deny you these rights or to ask you to surrender the rights.
+        These restrictions translate to certain responsibilities for you if you
+        distribute copies of the software, or if you modify it.
+        
+          For example, if you distribute copies of such a program, whether
+        gratis or for a fee, you must give the recipients all the rights that
+        you have.  You must make sure that they, too, receive or can get the
+        source code.  And you must show them these terms so they know their
+        rights.
+        
+          We protect your rights with two steps: (1) copyright the software, and
+        (2) offer you this license which gives you legal permission to copy,
+        distribute and/or modify the software.
+        
+          Also, for each author's protection and ours, we want to make certain
+        that everyone understands that there is no warranty for this free
+        software.  If the software is modified by someone else and passed on, we
+        want its recipients to know that what they have is not the original, so
+        that any problems introduced by others will not reflect on the original
+        authors' reputations.
+        
+          Finally, any free program is threatened constantly by software
+        patents.  We wish to avoid the danger that redistributors of a free
+        program will individually obtain patent licenses, in effect making the
+        program proprietary.  To prevent this, we have made it clear that any
+        patent must be licensed for everyone's free use or not licensed at all.
+        
+          The precise terms and conditions for copying, distribution and
+        modification follow.
+        
+                            GNU GENERAL PUBLIC LICENSE
+           TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+        
+          0. This License applies to any program or other work which contains
+        a notice placed by the copyright holder saying it may be distributed
+        under the terms of this General Public License.  The "Program", below,
+        refers to any such program or work, and a "work based on the Program"
+        means either the Program or any derivative work under copyright law:
+        that is to say, a work containing the Program or a portion of it,
+        either verbatim or with modifications and/or translated into another
+        language.  (Hereinafter, translation is included without limitation in
+        the term "modification".)  Each licensee is addressed as "you".
+        
+        Activities other than copying, distribution and modification are not
+        covered by this License; they are outside its scope.  The act of
+        running the Program is not restricted, and the output from the Program
+        is covered only if its contents constitute a work based on the
+        Program (independent of having been made by running the Program).
+        Whether that is true depends on what the Program does.
+        
+          1. You may copy and distribute verbatim copies of the Program's
+        source code as you receive it, in any medium, provided that you
+        conspicuously and appropriately publish on each copy an appropriate
+        copyright notice and disclaimer of warranty; keep intact all the
+        notices that refer to this License and to the absence of any warranty;
+        and give any other recipients of the Program a copy of this License
+        along with the Program.
+        
+        You may charge a fee for the physical act of transferring a copy, and
+        you may at your option offer warranty protection in exchange for a fee.
+        
+          2. You may modify your copy or copies of the Program or any portion
+        of it, thus forming a work based on the Program, and copy and
+        distribute such modifications or work under the terms of Section 1
+        above, provided that you also meet all of these conditions:
+        
+            a) You must cause the modified files to carry prominent notices
+            stating that you changed the files and the date of any change.
+        
+            b) You must cause any work that you distribute or publish, that in
+            whole or in part contains or is derived from the Program or any
+            part thereof, to be licensed as a whole at no charge to all third
+            parties under the terms of this License.
+        
+            c) If the modified program normally reads commands interactively
+            when run, you must cause it, when started running for such
+            interactive use in the most ordinary way, to print or display an
+            announcement including an appropriate copyright notice and a
+            notice that there is no warranty (or else, saying that you provide
+            a warranty) and that users may redistribute the program under
+            these conditions, and telling the user how to view a copy of this
+            License.  (Exception: if the Program itself is interactive but
+            does not normally print such an announcement, your work based on
+            the Program is not required to print an announcement.)
+        
+        These requirements apply to the modified work as a whole.  If
+        identifiable sections of that work are not derived from the Program,
+        and can be reasonably considered independent and separate works in
+        themselves, then this License, and its terms, do not apply to those
+        sections when you distribute them as separate works.  But when you
+        distribute the same sections as part of a whole which is a work based
+        on the Program, the distribution of the whole must be on the terms of
+        this License, whose permissions for other licensees extend to the
+        entire whole, and thus to each and every part regardless of who wrote it.
+        
+        Thus, it is not the intent of this section to claim rights or contest
+        your rights to work written entirely by you; rather, the intent is to
+        exercise the right to control the distribution of derivative or
+        collective works based on the Program.
+        
+        In addition, mere aggregation of another work not based on the Program
+        with the Program (or with a work based on the Program) on a volume of
+        a storage or distribution medium does not bring the other work under
+        the scope of this License.
+        
+          3. You may copy and distribute the Program (or a work based on it,
+        under Section 2) in object code or executable form under the terms of
+        Sections 1 and 2 above provided that you also do one of the following:
+        
+            a) Accompany it with the complete corresponding machine-readable
+            source code, which must be distributed under the terms of Sections
+            1 and 2 above on a medium customarily used for software interchange; or,
+        
+            b) Accompany it with a written offer, valid for at least three
+            years, to give any third party, for a charge no more than your
+            cost of physically performing source distribution, a complete
+            machine-readable copy of the corresponding source code, to be
+            distributed under the terms of Sections 1 and 2 above on a medium
+            customarily used for software interchange; or,
+        
+            c) Accompany it with the information you received as to the offer
+            to distribute corresponding source code.  (This alternative is
+            allowed only for noncommercial distribution and only if you
+            received the program in object code or executable form with such
+            an offer, in accord with Subsection b above.)
+        
+        The source code for a work means the preferred form of the work for
+        making modifications to it.  For an executable work, complete source
+        code means all the source code for all modules it contains, plus any
+        associated interface definition files, plus the scripts used to
+        control compilation and installation of the executable.  However, as a
+        special exception, the source code distributed need not include
+        anything that is normally distributed (in either source or binary
+        form) with the major components (compiler, kernel, and so on) of the
+        operating system on which the executable runs, unless that component
+        itself accompanies the executable.
+        
+        If distribution of executable or object code is made by offering
+        access to copy from a designated place, then offering equivalent
+        access to copy the source code from the same place counts as
+        distribution of the source code, even though third parties are not
+        compelled to copy the source along with the object code.
+        
+          4. You may not copy, modify, sublicense, or distribute the Program
+        except as expressly provided under this License.  Any attempt
+        otherwise to copy, modify, sublicense or distribute the Program is
+        void, and will automatically terminate your rights under this License.
+        However, parties who have received copies, or rights, from you under
+        this License will not have their licenses terminated so long as such
+        parties remain in full compliance.
+        
+          5. You are not required to accept this License, since you have not
+        signed it.  However, nothing else grants you permission to modify or
+        distribute the Program or its derivative works.  These actions are
+        prohibited by law if you do not accept this License.  Therefore, by
+        modifying or distributing the Program (or any work based on the
+        Program), you indicate your acceptance of this License to do so, and
+        all its terms and conditions for copying, distributing or modifying
+        the Program or works based on it.
+        
+          6. Each time you redistribute the Program (or any work based on the
+        Program), the recipient automatically receives a license from the
+        original licensor to copy, distribute or modify the Program subject to
+        these terms and conditions.  You may not impose any further
+        restrictions on the recipients' exercise of the rights granted herein.
+        You are not responsible for enforcing compliance by third parties to
+        this License.
+        
+          7. If, as a consequence of a court judgment or allegation of patent
+        infringement or for any other reason (not limited to patent issues),
+        conditions are imposed on you (whether by court order, agreement or
+        otherwise) that contradict the conditions of this License, they do not
+        excuse you from the conditions of this License.  If you cannot
+        distribute so as to satisfy simultaneously your obligations under this
+        License and any other pertinent obligations, then as a consequence you
+        may not distribute the Program at all.  For example, if a patent
+        license would not permit royalty-free redistribution of the Program by
+        all those who receive copies directly or indirectly through you, then
+        the only way you could satisfy both it and this License would be to
+        refrain entirely from distribution of the Program.
+        
+        If any portion of this section is held invalid or unenforceable under
+        any particular circumstance, the balance of the section is intended to
+        apply and the section as a whole is intended to apply in other
+        circumstances.
+        
+        It is not the purpose of this section to induce you to infringe any
+        patents or other property right claims or to contest validity of any
+        such claims; this section has the sole purpose of protecting the
+        integrity of the free software distribution system, which is
+        implemented by public license practices.  Many people have made
+        generous contributions to the wide range of software distributed
+        through that system in reliance on consistent application of that
+        system; it is up to the author/donor to decide if he or she is willing
+        to distribute software through any other system and a licensee cannot
+        impose that choice.
+        
+        This section is intended to make thoroughly clear what is believed to
+        be a consequence of the rest of this License.
+        
+          8. If the distribution and/or use of the Program is restricted in
+        certain countries either by patents or by copyrighted interfaces, the
+        original copyright holder who places the Program under this License
+        may add an explicit geographical distribution limitation excluding
+        those countries, so that distribution is permitted only in or among
+        countries not thus excluded.  In such case, this License incorporates
+        the limitation as if written in the body of this License.
+        
+          9. The Free Software Foundation may publish revised and/or new versions
+        of the General Public License from time to time.  Such new versions will
+        be similar in spirit to the present version, but may differ in detail to
+        address new problems or concerns.
+        
+        Each version is given a distinguishing version number.  If the Program
+        specifies a version number of this License which applies to it and "any
+        later version", you have the option of following the terms and conditions
+        either of that version or of any later version published by the Free
+        Software Foundation.  If the Program does not specify a version number of
+        this License, you may choose any version ever published by the Free Software
+        Foundation.
+        
+          10. If you wish to incorporate parts of the Program into other free
+        programs whose distribution conditions are different, write to the author
+        to ask for permission.  For software which is copyrighted by the Free
+        Software Foundation, write to the Free Software Foundation; we sometimes
+        make exceptions for this.  Our decision will be guided by the two goals
+        of preserving the free status of all derivatives of our free software and
+        of promoting the sharing and reuse of software generally.
+        
+                                    NO WARRANTY
+        
+          11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+        FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+        OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+        PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+        OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+        MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+        TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+        PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+        REPAIR OR CORRECTION.
+        
+          12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+        WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+        REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+        INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+        OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+        TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+        YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+        PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+        POSSIBILITY OF SUCH DAMAGES.
+        
+                             END OF TERMS AND CONDITIONS
+        
+                    How to Apply These Terms to Your New Programs
+        
+          If you develop a new program, and you want it to be of the greatest
+        possible use to the public, the best way to achieve this is to make it
+        free software which everyone can redistribute and change under these terms.
+        
+          To do so, attach the following notices to the program.  It is safest
+        to attach them to the start of each source file to most effectively
+        convey the exclusion of warranty; and each file should have at least
+        the "copyright" line and a pointer to where the full notice is found.
+        
+            <one line to give the program's name and a brief idea of what it does.>
+            Copyright (C) <year>  <name of author>
+        
+            This program is free software; you can redistribute it and/or modify
+            it under the terms of the GNU General Public License as published by
+            the Free Software Foundation; either version 2 of the License, or
+            (at your option) any later version.
+        
+            This program is distributed in the hope that it will be useful,
+            but WITHOUT ANY WARRANTY; without even the implied warranty of
+            MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+            GNU General Public License for more details.
+        
+            You should have received a copy of the GNU General Public License along
+            with this program; if not, write to the Free Software Foundation, Inc.,
+            51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+        
+        Also add information on how to contact you by electronic and paper mail.
+        
+        If the program is interactive, make it output a short notice like this
+        when it starts in an interactive mode:
+        
+            Gnomovision version 69, Copyright (C) year name of author
+            Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+            This is free software, and you are welcome to redistribute it
+            under certain conditions; type `show c' for details.
+        
+        The hypothetical commands `show w' and `show c' should show the appropriate
+        parts of the General Public License.  Of course, the commands you use may
+        be called something other than `show w' and `show c'; they could even be
+        mouse-clicks or menu items--whatever suits your program.
+        
+        You should also get your employer (if you work as a programmer) or your
+        school, if any, to sign a "copyright disclaimer" for the program, if
+        necessary.  Here is a sample; alter the names:
+        
+          Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+          `Gnomovision' (which makes passes at compilers) written by James Hacker.
+        
+          <signature of Ty Coon>, 1 April 1989
+          Ty Coon, President of Vice
+        
+        This General Public License does not permit incorporating your program into
+        proprietary programs.  If your program is a subroutine library, you may
+        consider it more useful to permit linking proprietary applications with the
+        library.  If this is what you want to do, use the GNU Lesser General
+        Public License instead of this License.
+        
+Project-URL: Homepage, https://github.com/kdeldycke/workflows
+Project-URL: Repository, https://github.com/kdeldycke/workflows
+Project-URL: Funding, https://github.com/sponsors/kdeldycke
+Project-URL: Issues, https://github.com/kdeldycke/workflows/issues
+Project-URL: Changelog, https://github.com/kdeldycke/workflows/blob/main/changelog.md
+Keywords: build-automation,changelog-formatter,ci-cd,cli,formatting,github-actions,labels,linting,markdown,mypy,nuitka,packaging,pypi,python,release-automation,sphinx,sponsorship,terminal,typo,workflow-reusable,yaml
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Framework :: Sphinx
+Classifier: Framework :: Pelican
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Unix Shell
+Classifier: Topic :: Documentation :: Sphinx
+Classifier: Topic :: File Formats :: JSON
+Classifier: Topic :: Security
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Topic :: Software Development :: Compilers
+Classifier: Topic :: Software Development :: Documentation
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development :: Version Control :: Git
+Classifier: Topic :: System :: Archiving :: Packaging
+Classifier: Topic :: System :: Installation/Setup
+Classifier: Topic :: System :: Shells
+Classifier: Topic :: System :: Software Distribution
+Classifier: Topic :: Terminals
+Classifier: Topic :: Text Processing :: Markup :: HTML
+Classifier: Topic :: Text Processing :: Markup :: Markdown
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: black ~=24.4.2
+Requires-Dist: bump-my-version ~=0.24.0
+Requires-Dist: click-extra ~=4.8.3
+Requires-Dist: mypy ~=1.10.0
+Requires-Dist: packaging ~=24.1
+Requires-Dist: PyDriller ~=2.6
+Requires-Dist: pyproject-metadata ~=0.8.0
+Requires-Dist: wcmatch ~=8.5.2
+Requires-Dist: tomli ~=2.0.1 ; python_version < "3.11"
+
+# `gha-utils` CLI + reusable workflows
+
+[![Last release](https://img.shields.io/pypi/v/gha-utils.svg)](https://pypi.python.org/pypi/gha-utils)
+[![Python versions](https://img.shields.io/pypi/pyversions/gha-utils.svg)](https://pypi.python.org/pypi/gha-utils)
+[![Type checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
+
+`gha-utils` stands for **G**it**H**ub **A**ction workflows **Util**itie**s**.
+
+Maintaining project takes time. This repository contains the code of the `gha-utils` CLI and a collection of reusable workflows to:
+
+- maintain a Python project, its CLI, doc, QA, etc.
+- maintain an Awesome List project.
+
+## `gha-utils` CLI
+
+### Executables
+
+Standalone executables of `gha-utils`'s latest version are available as direct downloads for several platforms and architectures:
+
+| Platform          | `x86_64`                                                                                                                         | `arm64`                                                                                                                          |
+| ----------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
+| **Linux** | [Download `gha-utils-linux-x64.bin`](https://github.com/kdeldycke/workflows/releases/latest/download/gha-utils-linux-x64.bin)     |                                                                                                                                  |
+| **macOS**         | [Download `gha-utils-macos-x64.bin`](https://github.com/kdeldycke/workflows/releases/latest/download/gha-utils-macos-x64.bin)     | [Download `gha-utils-macos-arm64.bin`](https://github.com/kdeldycke/workflows/releases/latest/download/gha-utils-macos-arm64.bin) |
+| **Windows**       | [Download `gha-utils-windows-x64.exe`](https://github.com/kdeldycke/workflows/releases/latest/download/gha-utils-windows-x64.exe) |                                                                                                                                  |
+
+### Run dev version
+
+```shell-session
+$ git clone https://github.com/kdeldycke/workflows
+$ cd workflows
+$ python -m pip install uv
+$ uv venv
+$ source .venv/bin/activate
+$ uv pip install .
+$ uv run gha-utils
+```
+
+## Reusable workflows collection
+
+This repository contains workflows to automate most of the boring tasks.
+
+These workflows are mostly used for Python projects and their documentation, but not only. They're all [reusable GitHub actions workflows](https://docs.github.com/en/actions/learn-github-actions/reusing-workflows).
+
+Reasons for a centralized workflow repository:
+
+- reusability of course: no need to update dozens of repository where 95% of workflows are the same
+- centralize all dependencies pertaining to automation: think of the point-release of an action that triggers dependabot upgrade to all your repositories depending on it
+
+### Guidelines
+
+I don't want to copy-n-past, keep in sync and maintain another `N`th CI/CD file at the root of my repositories.
+
+So my policy is: move every repository-specific config in a `pyproject.toml` file, or hide the gory details in a reused workflow.
+
+### `.github/workflows/docs.yaml` jobs
+
+- Autofix typos
+
+- Optimize images
+
+- Keep `.mailmap` up to date
+
+- Update dependency graph of Python projects
+
+  - **Requires**:
+    - Python package with a `pyproject.toml` file
+
+- Build Sphinx-based documentation and publish it to GitHub Pages
+
+  - **Requires**:
+    - Python package with a `pyproject.toml` file
+    - All Sphinx dependencies in a `docs` [extra dependency group](https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#dependencies-and-requirements):
+      ```toml
+      [project.optional-dependencies]
+      docs = [
+          "furo == 2024.1.29",
+          "myst-parser ~= 3.0.0",
+          "sphinx >= 6",
+          ...
+      ]
+      ```
+    - Sphinx configuration file at `docs/conf.py`
+
+- Sync awesome projects from `awesome-template` repository
+
+### Why all these `requirements/*.txt` files?
+
+Let's look for example at the `lint-yaml` job from [`.github/workflows/lint.yaml`](https://github.com/kdeldycke/workflows/blob/main/.github/workflows/lint.yaml#L126). Here we only need the `yamllint` CLI. This CLI is [distributed on PyPi](https://pypi.org/project/yamllint/). So before executing it, we could have simply run the following step:
+
+```yaml
+  - name: Install yamllint
+    run: |
+      pip install yamllint
+```
+
+Instead, we install it via the [`requirements/yamllint.txt` file](https://github.com/kdeldycke/workflows/blob/main/requirements/yamllint.txt).
+
+Why? Because I want the version of `yamllint` to be pinned. By pinning it, I make the workflow stable, predictable and reproducible.
+
+So why use a dedicated requirements file? Why don't we simply add the version? Like this:
+
+```yaml
+  - name: Install yamllint
+    run: |
+      pip install yamllint==1.35.1
+```
+
+That would indeed pin the version. But it requires the maintainer (me) to keep track of new release and update manually the version string. That's a lot of work. And I'm lazy. So this should be automated.
+
+To automate that, the only practical way I found was to rely on dependabot. But dependabot cannot update arbitrary versions in `run:` YAML blocks. It [only supports `requirements.txt` and `pyproject.toml`](https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#pip-and-pip-compile) files for Python projects.
+
+So to keep track of new versions of dependencies while keeping them stable, we've hard-coded all Python libraries and CLIs in the `requirements/*.txt` files. All with pinned versions.
+
+And for the case we need to install all dependencies in one go, we have a [`requirements.txt` file at the root](https://github.com/kdeldycke/workflows/blob/main/requirements.txt) that is referencing all files from the `requirements/` subfolder.
+
+### Permissions and token
+
+This repository updates itself via GitHub actions. It particularly updates its own YAML files in `.github/workflows`. That's forbidden by default. So we need extra permissions.
+
+Usually, to grant special permissions to some jobs, you use the [`permissions` parameter in workflow](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#permissions) files. It looks like this:
+
+```yaml
+on: (...)
+
+jobs:
+
+  my-job:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+
+    steps: (...)
+```
+
+But the `contents: write` permission doesn't allow write access to the workflow files in the `.github` subfolder. There is `actions: write`, but it only covers workflow runs, not their YAML source file. Even a `permissions: write-all` doesn't work. So you cannot use the `permissions` parameter to allow a repository's workflow update its own workflow files.
+
+You will always end up with this kind or errors:
+
+```text
+   ! [remote rejected] branch_xxx -> branch_xxx (refusing to allow a GitHub App to create or update workflow `.github/workflows/my_workflow.yaml` without `workflows` permission)
+
+  error: failed to push some refs to 'https://github.com/kdeldycke/my-repo'
+```
+
+> \[!NOTE\]
+> That's also why the Settings > Actions > General > Workflow permissions parameter on your repository has no effect on this issue, even with the `Read and write permissions` set:
+> ![](docs/assets/repo-workflow-permissions.png)
+
+To bypass the limitation, we rely on a custom access token. By convention, we call it `WORKFLOW_UPDATE_GITHUB_PAT`. It will be used, [in place of the default `secrets.GITHUB_TOKEN`](https://github.com/search?q=repo%3Akdeldycke%2Fworkflows%20WORKFLOW_UPDATE_GITHUB_PAT&type=code), in steps in which we need to change the workflow YAML files.
+
+To create this custom `WORKFLOW_UPDATE_GITHUB_PAT`:
+
+- From your GitHub user, go to `Settings` > `Developer Settings` > `Personal Access Tokens` > `Fine-grained tokens`
+- Click on the `Generate new token` button
+- Choose a good token name like `workflow-self-update` to make your intention clear
+- Choose `Only select repositories` and the list the repositories in needs of updating their workflow YAML files
+- In the `Repository permissions` drop-down, sets:
+  - `Contents`: `Access: **Read and Write**`
+  - `Metadata` (mandatory): `Access: **Read-only**`
+  - `Pull Requests`: `Access: **Read and Write**`
+  - `Workflows`: `Access: **Read and Write**`
+    > \[!NOTE\]
+    > This is the only place where I can have control over the `Workflows` permission, which is not supported by the `permissions:` parameter in YAML files.
+- Now save these parameters and copy the `github_pat_XXXX` secret token
+- Got to your repo > `Settings` > `Security` > `Secrets and variables` > `Actions` > `Secrets` > `Repository secrets` and click `New repository secrets`
+- Name your secret `WORKFLOW_UPDATE_GITHUB_PAT` and copy the `github_pat_XXXX` token in the `Secret` field
+
+Now re-run your actions and they should be able to update the workflow files in `.github` folder without the `refusing to allow a GitHub App to create or update workflow` error.
+
+### Release management
+
+It turns out [Release Engineering is a full-time job, and full of edge-cases](https://blog.axo.dev/2023/02/cargo-dist).
+
+Rust has [`cargo-dist`](https://github.com/axodotdev/cargo-dist). Go has... ? But there is no equivalent for Python.
+
+So I made up a [`release.yaml` workflow](https://github.com/kdeldycke/workflows/blob/main/.github/workflows/release.yaml), which:
+
+1. Extracts project metadata from `pyproject.toml`
+1. Generates a build matrix of all commits / os / arch / CLI entry points
+1. Build Python wheel with Twine
+1. Compile binaries of all CLI with Nuitka
+1. Tag the release commit in Git
+1. Publish new version to PyPi
+1. Publish a GitHub release
+1. Attach and rename build artifacts to it
+
+## Changelog
+
+A [detailed changelog](changelog.md) is available.
+
+## Used in
+
+Check these projects to get real-life examples of usage and inspiration:
+
+- ![GitHub stars](https://img.shields.io/github/stars/kdeldycke/awesome-falsehood?label=%E2%AD%90&style=flat-square) [Awesome Falsehood](https://github.com/kdeldycke/awesome-falsehood#readme) - Falsehoods Programmers Believe in.
+- ![GitHub stars](https://img.shields.io/github/stars/kdeldycke/awesome-engineering-team-management?label=%E2%AD%90&style=flat-square) [Awesome Engineering Team Management](https://github.com/kdeldycke/awesome-engineering-team-management#readme) - How to transition from software development to engineering management.
+- ![GitHub stars](https://img.shields.io/github/stars/kdeldycke/awesome-iam?label=%E2%AD%90&style=flat-square) [Awesome IAM](https://github.com/kdeldycke/awesome-iam#readme) - Identity and Access Management knowledge for cloud platforms.
+- ![GitHub stars](https://img.shields.io/github/stars/kdeldycke/awesome-billing?label=%E2%AD%90&style=flat-square) [Awesome Billing](https://github.com/kdeldycke/awesome-billing#readme) - Billing & Payments knowledge for cloud platforms.
+- ![GitHub stars](https://img.shields.io/github/stars/kdeldycke/meta-package-manager?label=%E2%AD%90&style=flat-square) [Meta Package Manager](https://github.com/kdeldycke/meta-package-manager#readme) - A unifying CLI for multiple package managers.
+- ![GitHub stars](https://img.shields.io/github/stars/kdeldycke/mail-deduplicate?label=%E2%AD%90&style=flat-square) [Mail Deduplicate](https://github.com/kdeldycke/mail-deduplicate#readme) - A CLI to deduplicate similar emails.
+- ![GitHub stars](https://img.shields.io/github/stars/kdeldycke/dotfiles?label=%E2%AD%90&style=flat-square) [dotfiles](https://github.com/kdeldycke/dotfiles#readme) - macOS dotfiles for Python developers.
+- ![GitHub stars](https://img.shields.io/github/stars/kdeldycke/click-extra?label=%E2%AD%90&style=flat-square) [Click Extra](https://github.com/kdeldycke/click-extra#readme) - Extra colorization and configuration loading for Click.
+- ![GitHub stars](https://img.shields.io/github/stars/themagicalmammal/wikibot?label=%E2%AD%90&style=flat-square) [Wiki bot](https://github.com/themagicalmammal/wikibot#readme) - A bot which provides features from Wikipedia like summary, title searches, location API etc.
+- ![GitHub stars](https://img.shields.io/github/stars/kdeldycke/workflows?label=%E2%AD%90&style=flat-square) [workflows](https://github.com/kdeldycke/workflows#readme) - Itself. Eat your own dog-food.
+- ![GitHub stars](https://img.shields.io/github/stars/themagicalmammal/stock-analyser?label=%E2%AD%90&style=flat-square) [Stock Analysis](https://github.com/themagicalmammal/stock-analyser#readme) - Simple to use interfaces for basic technical analysis of stocks.
+- ![GitHub stars](https://img.shields.io/github/stars/themagicalmammal/genetictabler?label=%E2%AD%90&style=flat-square) [GeneticTabler](https://github.com/themagicalmammal/genetictabler#readme) - Time Table Scheduler using Genetic Algorithms.
+- ![GitHub stars](https://img.shields.io/github/stars/themagicalmammal/excel-write?label=%E2%AD%90&style=flat-square) [Excel Write](https://github.com/themagicalmammal/excel-write#readme) - Optimised way to write in excel files.
+
+Feel free to send a PR to add your project in this list if you are relying on these scripts.
+
+## Release process
+
+All steps of the release process and version management are automated in the
+[`changelog.yaml`](https://github.com/kdeldycke/workflows/blob/main/.github/workflows/changelog.yaml)
+and
+[`release.yaml`](https://github.com/kdeldycke/workflows/blob/main/.github/workflows/release.yaml)
+workflows.
+
+All there's left to do is to:
+
+- [check the open draft `prepare-release` PR](https://github.com/kdeldycke/workflows/pulls?q=is%3Apr+is%3Aopen+head%3Aprepare-release)
+  and its changes,
+- click the `Ready for review` button,
+- click the `Rebase and merge` button,
+- let the workflows tag the release and set back the `main` branch into a
+  development state.

gha_utils-4.0.1.dist-info/RECORD

@@ -0,0 +1,12 @@
+gha_utils/__init__.py,sha256=1a8CEcMGKikCGeMeqaQ930T3zbnVlJrfPJY_pjeNTBQ,865
+gha_utils/__main__.py,sha256=Dck9BjpLXmIRS83k0mghAMcYVYiMiFLltQdfRuMSP_Q,1703
+gha_utils/changelog.py,sha256=NvS5UFpXs8B-5uBQe6MM-L8hP5ZEAPDTQ-ed1npE3C0,5631
+gha_utils/cli.py,sha256=7o0dUoj3ElTEh0s1p83j-om2Lgc2HpJZuT-ZwdN2MmI,6764
+gha_utils/mailmap.py,sha256=Cbsf35XRU_1M-POvzi80OPngtNIQi1HTeTLnZp8jyGE,3721
+gha_utils/metadata.py,sha256=5uBMdlmkqQ6DEsAEKB4gmRiP8PQZS8PX0J1WV1DbLNU,40917
+gha_utils/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+gha_utils-4.0.1.dist-info/METADATA,sha256=KYS88V24gayu6rbHoilwszBpMQutMDpEMYCBXZmRWfA,37770
+gha_utils-4.0.1.dist-info/WHEEL,sha256=mguMlWGMX-VHnMpKOjjQidIo1ssRlCFu4a4mBpz1s2M,91
+gha_utils-4.0.1.dist-info/entry_points.txt,sha256=8bJOwQYf9ZqsLhBR6gUCzvwLNI9f8tiiBrJ3AR0EK4o,54
+gha_utils-4.0.1.dist-info/top_level.txt,sha256=C94Blb61YkkyPBwCdM3J_JPDjWH0lnKa5nGZeZ5M6yE,10
+gha_utils-4.0.1.dist-info/RECORD,,

gha_utils-4.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (70.1.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

gha_utils-4.0.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+gha-utils = gha_utils.__main__:main

gha_utils-4.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+gha_utils