denisa / clq Goto Github PK

In a pull-request build, fail if the tag exists already

go vet and golint-ci in Makefile and github build
https://github.com/golangci/golangci-lint

for example, if changelog has italicized or bold text, the output doesn’t.

First of all thank you for this awesome changelog query tool! I am using the clq indirectly with your GitHub Action but I posted the issue here directly since it is with regards to disabling the version validation. The issue I encounter is that I usually have an Added section for minor releases. As long as it is backwards comaptible, having an Added section is valid according to semver. However, right now the clq throws an error which terminates the GitHub Action.

Is it then possible to have an Added section also for minor releases? If not it would be great to have a new validation mode which does not validate the version but still checks the syntax of the changelog 😄

EDIT: Perhaps it's also an idea to add a quiet mode that raises warnings instead of errors, so the GitHub Action can continue and give an output.

this query returns true if one of the pre-release elements of this version matches the pattern

eg:
“1.2.3-SNAPSHOT”.hasPrerelease(“SNAPSHOT”) -> true
“1.2.3-rc.12-SNAPSHOT”.hasPrerelease(“SNAPSHOT”) -> true
“1.2.3-rc.12”.hasPrerelease(“SNAPSHOT”) -> false
“1.2.3-rc.12-SNAPSHOT”.hasPrerelease(“rc.12”) -> true

clq -query title

Ensure proper releases and change kinds

Namely:

clq              -> query, validator
changelog -> n/a
query         -> changelog
validator    -> changelog

https://github.com/returntocorp/semgrep

-version

according to:

• major release trigger
  • Added for new features.
  • Removed for now removed features.
• minor release trigger
  • Changed for changes in existing functionality.
  • Deprecated for soon-to-be removed features.
• bug-fix release trigger
  • Fixed for any bug fixes.
  • Security in case of vulnerabilities.

https://snyk.io/

Will wait for support of mod.go directly from GitHub

A user should be able to define which mappings triggers which version change

invocation is
docker run -i denisa/clq < CHANGELOG.md

see https://blog.anoff.io/2018-07-31-diagrams-with-plantuml/

to ensure that all tests are green before tagging

https://help.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idneeds

• see use of emoji in https://karabiner-elements.pqrs.org/docs/releasenotes/
• see https://github.com/favoloso/conventional-changelog-emoji
• add as an optional configuration in the changeMap.json

https://github.com/golang-standards/project-layout
https://go.dev/doc/modules/layout

this could be used as the GitHub release body, for example

• all dates are valid
• release are sorted by date, with newer date first

Provide command-line option to control whether the top-most release can be a pre-release

Using --release prohibits the release [Unreleased]

https://help.github.com/en/github/administering-a-repository/enabling-and-disabling-version-updates

https://img.shields.io/github/v/release/denisa/clq?include_prereleases&sort=semver

in a query for the status of a release, recognize & return pre-releases

anvil-open-software/toolkit#4

clq -query releases[i] -> all the field, json
clq -query releases[i].date
clq -query releases[i].label
clq -query releases[i].status
clq -query releases[i].version

i starts at 0

https://goreportcard.com/

ensure that the change kinds are sorted by implied version change, then alphabetically

if a change kind is present,

• it has an unordered list
• with at least one element

https://medium.com/@chemidy/create-the-smallest-and-secured-golang-docker-image-based-on-scratch-4752223b7324

Given a set of changelog.md
When clq is asked to validates them all clq *.md
Then clq does not stop at the first erroneous file