Skip to content

Commit

Permalink
feat: state machine ReprocessDocumentationPerPackage's behavior docum…
Browse files Browse the repository at this point in the history
…ented (#1497)

----

*By submitting this pull request, I confirm that my contribution is made
under the terms of the Apache-2.0 license*
  • Loading branch information
otaviomacedo authored Oct 9, 2024
1 parent 01a4d9a commit 5778a0e
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -489,6 +489,21 @@ more information about the available flags, check the documentation for
By default, an AppRegistry application will be created that is associated
with the stack you put the `ConstructHub` construct in.

### Re-processing specific packages

In some cases, you might need to re-generate the documentation for a given
package version. This is useful, for example, in a CI/CD pipeline, to make
sure there are no regressions before releasing a new version to production.

To re-process a specific package, start the execution of the state machine
called `ReprocessDocumentationPerPackage` with the following input:

```json
{
"Prefix": "data/<package-name>/v<package-version>"
}
```

## :raised_hand: Contributing

If you are looking to contribute to this project, but don't know where to start,
Expand Down

0 comments on commit 5778a0e

Please sign in to comment.