mirror of
https://github.com/awsdocs/aws-doc-sdk-examples.git
synced 2026-03-26 06:22:18 +00:00
a0c04bb976
Example output snippet: ``` Dry run, no changes will be made. --- Java:2:opensearch/current +++ Java:2:opensearch/expected @@ -42,7 +42,7 @@ - [AddTags](src/main/java/com/example/search/scenario/OpenSearchActions.java#L270) - [ChangeProgress](src/main/java/com/example/search/scenario/OpenSearchActions.java#L219) -- [CreateDomain](src/main/java/com/example/search/scenario/OpenSearchActions.java#L71) +- [CreateDomain](src/main/java/com/example/search/HelloOpenSearch.java#L6) - [DeleteDomain](src/main/java/com/example/search/scenario/OpenSearchActions.java#L117) - [DescribeDomain](src/main/java/com/example/search/scenario/OpenSearchActions.java#L192) - [ListDomainNames](src/main/java/com/example/search/scenario/OpenSearchActions.java#L170) Incorrect: Java:2:opensearch Rerun writeme.py to update README links and sections. WRITEME Run completed. ```
36 lines
1.2 KiB
YAML
36 lines
1.2 KiB
YAML
name: Validate WRITEMEs
|
|
|
|
# Controls when the action will run.
|
|
on: # yamllint disable-line rule:truthy
|
|
# Triggers the workflow on push or pull request events but only for the main branch
|
|
push:
|
|
branches: [main]
|
|
pull_request:
|
|
branches: [main]
|
|
|
|
# Allows you to run this workflow manually from the Actions tab
|
|
workflow_dispatch:
|
|
|
|
# A workflow run is made up of one or more jobs that can run sequentially or in parallel
|
|
jobs:
|
|
# This workflow contains a single job called "build"
|
|
build:
|
|
name: Validate WRITEMEs
|
|
# The type of runner that the job will run on
|
|
runs-on: ubuntu-latest
|
|
|
|
# Steps represent a sequence of tasks that will be executed as part of the job
|
|
steps:
|
|
- name: Checkout repo content
|
|
uses: actions/checkout@v4 # checkout the repository content to github runner.
|
|
- name: Setup Python
|
|
uses: actions/setup-python@v3
|
|
with:
|
|
python-version: 3.11 # install the python needed
|
|
- name: Install dependencies
|
|
run: >-
|
|
python3 -m pip install -r .tools/readmes/requirements.txt
|
|
- name: Check WRITEMEs
|
|
run: >-
|
|
python3 .tools/readmes/writeme.py --check --diff
|