Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: telekom-mms/Automated-Ansible-Role-Documentation
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: 2.0.0
Choose a base ref
...
head repository: telekom-mms/Automated-Ansible-Role-Documentation
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: 2.0.1
Choose a head ref
  • 13 commits
  • 7 files changed
  • 4 contributors

Commits on Oct 15, 2024

  1. chore(deps): update dependency mypy to v1.12.0

    @renovate
    renovate[bot] committed Oct 15, 2024

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
    GPG key ID: 4AEE18F83AFDEB23
    Expired
    Verified
    Learn about vigilant mode
    Copy the full SHA
    c0ad194 View commit details

  2. update changelog

    Telekom MMS GmbH committed Oct 15, 2024
    Copy the full SHA
    ade794a View commit details

Commits on Oct 21, 2024

  1. chore(deps): update dependency mypy to v1.12.1

    @renovate
    renovate[bot] committed Oct 21, 2024
    Copy the full SHA
    6a69cf6 View commit details

Commits on Oct 24, 2024

  1. chore(deps): update dependency mypy to v1.13.0

    @renovate
    renovate[bot] committed Oct 24, 2024
    Copy the full SHA
    632608c View commit details

Commits on Oct 25, 2024

  1. chore(deps): update actions/checkout digest to 11bd719

    @renovate
    renovate[bot] committed Oct 25, 2024
    Copy the full SHA
    606e6b0 View commit details

  2. chore(deps): update actions/checkout action to v4.2.2

    @renovate
    renovate[bot] committed Oct 25, 2024
    Copy the full SHA
    86598ee View commit details

Commits on Oct 26, 2024

  1. doc: Fix Ansible Galaxy role metadata URL 

    The location from the previous link was unknown and was redirected to
the Ansible Galaxy starting page. It seems that they replaced their
Ansible Galaxy and deprecated the old interface, breaking existing
links.
    @lingling9000
    lingling9000 committed Oct 26, 2024
    Copy the full SHA
    3b19b56 View commit details

  2. chore(deps): update actions/setup-python digest to 0b93645

    @renovate
    renovate[bot] committed Oct 26, 2024
    Copy the full SHA
    6cfd9d3 View commit details

Commits on Oct 29, 2024

  1. chore(deps): update dependency pytest-cov to v6

    @renovate
    renovate[bot] authored Oct 29, 2024
    Copy the full SHA
    f261076 View commit details

Commits on Oct 30, 2024

  1. Merge pull request #96 from telekom-mms/renovate/pytest-cov-6.x 

    chore(deps): update dependency pytest-cov to v6
    @rndmh3ro
    rndmh3ro authored Oct 30, 2024
    Copy the full SHA
    7ea4ca0 View commit details

Commits on Nov 1, 2024

  1. Merge branch 'main' into ansible-galaxy-link-fix

    @rndmh3ro
    rndmh3ro authored Nov 1, 2024
    Copy the full SHA
    faf144b View commit details

  2. Merge pull request #94 from lingling9000/ansible-galaxy-link-fix 

    doc: Fix Ansible Galaxy role metadata URL
    @rndmh3ro
    rndmh3ro authored Nov 1, 2024
    Copy the full SHA
    5f6a123 View commit details

  3. update changelog

    Telekom MMS GmbH committed Nov 1, 2024
    Copy the full SHA
    03fbe3d View commit details
Showing with 133 additions and 95 deletions.
  1. +1 −1 .github/workflows/pypi.yml
  2. +3 −3 .github/workflows/release.yml
  3. +2 −2 .github/workflows/test.yml
  4. +20 −0 CHANGELOG.md
  5. +1 −1 README.md
  6. +104 −86 poetry.lock
  7. +2 −2 pyproject.toml
2 changes: 1 addition & 1 deletion .github/workflows/pypi.yml
View file
Original file line number Diff line number Diff line change
@@ -18,7 +18,7 @@ jobs:
# IMPORTANT: this permission is mandatory for trusted publishing
id-token: write
steps:
- uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4

- name: Install poetry
run: pip install poetry
6 changes: 3 additions & 3 deletions .github/workflows/release.yml
View file
Original file line number Diff line number Diff line change
@@ -15,7 +15,7 @@ jobs:
pull-requests: read
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
fetch-depth: 0
persist-credentials: false
@@ -33,7 +33,7 @@ jobs:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Set up Python
uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3 # v5
uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5
with:
python-version: "3.10"

@@ -74,7 +74,7 @@ jobs:

# do a second checkout to prevent race situation
# changelog gets updated but action works on old commit id
- uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
ref: main

4 changes: 2 additions & 2 deletions .github/workflows/test.yml
View file
Original file line number Diff line number Diff line change
@@ -24,10 +24,10 @@ jobs:
- "3.13"
steps:
- name: Check out code
uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4

- name: Set up Python ${{ matrix.python }}
uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3 # v5
uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5
with:
python-version: ${{ matrix.python }}

20 changes: 20 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,12 +1,22 @@
# Changelog

## [2.0.1](https://github.com/telekom-mms/Automated-Ansible-Role-Documentation/tree/2.0.1) (2024-11-01)

[Full Changelog](https://github.com/telekom-mms/Automated-Ansible-Role-Documentation/compare/2.0.0...2.0.1)

**Fixed bugs:**

- \[Bug\] URL to role metadata in README.md broken [\#93](https://github.com/telekom-mms/Automated-Ansible-Role-Documentation/issues/93)

## [2.0.0](https://github.com/telekom-mms/Automated-Ansible-Role-Documentation/tree/2.0.0) (2024-10-14)

[Full Changelog](https://github.com/telekom-mms/Automated-Ansible-Role-Documentation/compare/1.2.0...2.0.0)

**Implemented enhancements:**

- \[Enhancement\] The markdown template should include the content of the description field [\#78](https://github.com/telekom-mms/Automated-Ansible-Role-Documentation/issues/78)
- Feature/generate defaults [\#81](https://github.com/telekom-mms/Automated-Ansible-Role-Documentation/pull/81) ([moritzrp](https://github.com/moritzrp))
- feat\(template\): add description to markdown template [\#79](https://github.com/telekom-mms/Automated-Ansible-Role-Documentation/pull/79) ([rndmh3ro](https://github.com/rndmh3ro))

**Fixed bugs:**

@@ -16,6 +26,16 @@

- \[Bug\] output\_template not used [\#69](https://github.com/telekom-mms/Automated-Ansible-Role-Documentation/issues/69)

**Merged pull requests:**

- chore\(deps\): update dependency black to v24.10.0 [\#86](https://github.com/telekom-mms/Automated-Ansible-Role-Documentation/pull/86) ([renovate[bot]](https://github.com/apps/renovate))
- chore\(deps\): update dependency pre-commit to v4.0.1 [\#85](https://github.com/telekom-mms/Automated-Ansible-Role-Documentation/pull/85) ([renovate[bot]](https://github.com/apps/renovate))
- Fix/stuff [\#84](https://github.com/telekom-mms/Automated-Ansible-Role-Documentation/pull/84) ([rndmh3ro](https://github.com/rndmh3ro))
- chore\(deps\): update actions/checkout action to v4.2.1 [\#83](https://github.com/telekom-mms/Automated-Ansible-Role-Documentation/pull/83) ([renovate[bot]](https://github.com/apps/renovate))
- chore\(deps\): update actions/checkout digest to eef6144 [\#82](https://github.com/telekom-mms/Automated-Ansible-Role-Documentation/pull/82) ([renovate[bot]](https://github.com/apps/renovate))
- chore\(deps\): update dependency pre-commit to v4 [\#80](https://github.com/telekom-mms/Automated-Ansible-Role-Documentation/pull/80) ([renovate[bot]](https://github.com/apps/renovate))
- Change entry point to aar-doc [\#76](https://github.com/telekom-mms/Automated-Ansible-Role-Documentation/pull/76) ([moritzrp](https://github.com/moritzrp))

## [1.2.0](https://github.com/telekom-mms/Automated-Ansible-Role-Documentation/tree/1.2.0) (2024-09-30)

[Full Changelog](https://github.com/telekom-mms/Automated-Ansible-Role-Documentation/compare/1.1.0...1.2.0)
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
@@ -103,7 +103,7 @@ As noted above, the template _must_ start and end with the markers as comments,

`{{ content }}` will contain the rendered builtin output specific template content. For Markdown, see [templates/markdown.j2](./templates/markdown.j2).

You will most likely want to skip using it in your own template however, and use the provided variables containing the [role metadata](https://galaxy.ansible.com/docs/contributing/creating_role.html#role-metadata) and [argument specs](https://docs.ansible.com/ansible/latest/user_guide/playbooks_reuse_roles.html#specification-format) directly. `aar-doc` does not manipulate the values coming in from the YAML files in any way.
You will most likely want to skip using it in your own template however, and use the provided variables containing the [role metadata](https://old-galaxy.ansible.com/docs/contributing/creating_role.html#role-metadata) and [argument specs](https://docs.ansible.com/ansible/latest/user_guide/playbooks_reuse_roles.html#specification-format) directly. `aar-doc` does not manipulate the values coming in from the YAML files in any way.

Template variables:

Loading