github.com/whyrusleeping/gx@v0.14.3/contrib/README.md (about)

     1  # Scripts that make using GX nicer
     2  
     3  ## gx-retrotag
     4  
     5  `gx-retrotag` retroactively adds git tags to commits that modify .gx/lastpubver
     6  (gx release commits).
     7  
     8  1. Fetches $remote (defaults to origin).
     9  2. Tags the relevant commits (on $branch only, defaults to master).
    10  3. Pushes the tags back to $remote.
    11  
    12  **Usage:**
    13  
    14  ```sh
    15  > ./gx-retrotag.sh [[remote] branch]
    16  ```
    17  
    18  ## gx-changelog
    19  
    20  `gx-changelog` generates a recursive changelog of PRs for a release. Currently,
    21  it only works with `go` projects hosted on GitHub that use a PR workflow.
    22  
    23  **Usage:**
    24  
    25  First, customize `REPO_FILTER` and `IGNORED_FILES` for your project:
    26  
    27  - `REPO_FILTER` -- Selects the repos to be included in the changelog.
    28  - `IGNORED_FILES` -- Specifies a set of files that should be excluded from the
    29    changelog. Any PRs _only_ touching these files will be ignored.
    30  
    31  Then, run the script in your project's root repo.
    32  
    33  **Requirements:**
    34  
    35  This script requires:
    36  
    37  * gx (obviously)
    38  * jq
    39  * go
    40  * zsh (the _best_ shell)
    41  * util-linux -- for the _awesome_ column command.
    42  * git
    43  * grep
    44  * sed
    45  
    46  If you care about that "portability", feel free to take a crack at improving
    47  this script.