diff --git a/doc.go b/doc.go index ef1c5791f..f03ee18fa 100644 --- a/doc.go +++ b/doc.go @@ -17,7 +17,7 @@ Please read the YourOwnRule example. # Library versioning The version is for the command line tool. So it does not represent the version of the library. It -means that the library does not follow sematinc versioning and any patch version bump may introduce +means that the library does not follow semantic versioning and any patch version bump may introduce some breaking changes. # Go version compatibility @@ -26,6 +26,8 @@ Minimum supported Go version is written in go.mod file in this library. That sai are actually not tested on CI. Last two major Go versions are recommended because they're tested on CI. For example, when the latest Go version is v1.22, v1.21 and v1.22 are nice to use. +https://github.com/rhysd/actionlint/blob/main/go.mod + # Other documentations All documentations for actionlint can be found in the following page. diff --git a/docs/api.md b/docs/api.md index ffaad7517..c72fe4b97 100644 --- a/docs/api.md +++ b/docs/api.md @@ -36,14 +36,14 @@ Followings are unexhaustive list of interesting APIs. - `ActionMetadata` is a struct for action metadata file (`action.yml`). It is used to check inputs specified at `with:` and typing `steps.{id}.outputs` object strictly. - `PopularActions` global variable is the data set of popular actions' metadata collected by [the script](../scripts/generate-popular-actions). -- `AllWebhookTypes` global variable is the mapping from all webhook names to their types collected by [the scirpt](../scripts/generate-webhook-events). +- `AllWebhookTypes` global variable is the mapping from all webhook names to their types collected by [the script](../scripts/generate-webhook-events). - `WorkflowKeyAvailability()` returns available context names and special function names for the given workflow key like - `jobs..outputs.`. This function uses the data collected by [the scirpt](../scripts/generate-availability). + `jobs..outputs.`. This function uses the data collected by [the script](../scripts/generate-availability). ## Library versioning The version of this repository is for command line tool `actionlint`. So it does not represent the version of the library. -It means that the library does not follow sematinc versioning and any patch version bump may introduce some breaking changes. +It means that the library does not follow semantic versioning and any patch version bump may introduce some breaking changes. ## Go version compatibility