Skip to content

Checks the changelog has a ## Unreleased section via a status check

Notifications You must be signed in to change notification settings

xorima/changelog_validator

Repository files navigation

changelog_validator

Checks the changelog has a ## Unreleased section via a status check

Configuration

Environment Variables

This app uses the following environments variables:

Name Required Description
GITHUB_TOKEN Yes Token to access the github api, this will be used to write the status to the pr
SECRET_TOKEN No If supplied it will do a HMAC check against the incomming request
COMMENTS_ENABLED No If supplied it will comment what type of bump on the pr

Webhook

To configure the webhook you will want to do the following:

URL: <https://example.com/handler>
Events:
  Let me select:
    Pull Requests (Only)

If you set a HMAC secret ensure that SECRET_TOKEN is set to the same secret value

Docker images

Docker images are supplied under Xorima on docker hub, https://hub.docker.com/r/xorima/changelog_validator/

About

Checks the changelog has a ## Unreleased section via a status check

Resources

Stars

Watchers

Forks

Packages

No packages published