pcu 0.6.3

A CI tool to update change log in a PR
Documentation

Pcu

Crates.io MIT licensed circleci-badge Rust 1.87+ FOSSA Status Docs BuyMeaCoffee GitHubSponsors

A CI utility to update the Unreleased section of the changelog with the title of the pull request and include a link to the pull request.

Feature set

  • Use GitHub as source control system
  • Use of CircleCI as CI

CLI Usage

LinkedIn announcements

pcu can share a release announcement to LinkedIn in two ways:

  1. As a dedicated subcommand

    • Build content from PRLOG or pass your own text
    • Optionally include a GitHub release link

    Examples:

    # Provide text directly
    pcu linkedin share --author-urn "urn:li:organization:123" --text "v0.6.2 released"
    
    # Build from PRLOG release notes
    pcu linkedin share --author-urn "urn:li:organization:123" --from-release --version 0.6.2 --prefix v
    
  2. As part of the release flow

    • Add the flag to share after the GitHub release is created
    pcu release version 0.6.2 --prefix v --linkedin-share
    

Configuration (environment variables or pcu.toml):

  • LINKEDIN_ACCESS_TOKEN or key linkedin_access_token
  • LINKEDIN_AUTHOR_URN or key linkedin_author_urn
  • Optional: dev_platform, username, reponame to compute the GitHub release URL

Notes:

  • The LinkedIn client posts to the Posts REST API and requires header X-Restli-Protocol-Version: 2.0.0 (handled internally).
  • Tokens must be stored in CI secrets; never commit them.

Install the CLI using cargo install.


cargo install pcu

Run in the CI script following successful completion of build tests.

pcu 

The change log will be amended and committed as part of the change, triggering a recheck. On the recheck pcu will exit early as the change has already been applied.

Help provides all the options


$ pcu -h
A CI tool to update change log in a PR

Usage: pcu [OPTIONS]

Options:
  -v, --verbose...   Increase logging verbosity
  -q, --quiet...     Decrease logging verbosity
  -s, --sign <SIGN>  [possible values: gpg, none]
  -h, --help         Print help
  -V, --version      Print version
$

License

Licensed under either of

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.