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: tj-actions/auto-doc
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: v1.5.0
Choose a base ref
...
head repository: tj-actions/auto-doc
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: v1.6.0
Choose a head ref
  • 6 commits
  • 7 files changed
  • 4 contributors

Commits on Dec 4, 2022

  1. Copy the full SHA
    b4ef1e9 View commit details
  2. Upgraded from v1.4.3 -> v1.5.0 (#374)

    Co-authored-by: jackton1 <jackton1@users.noreply.github.com>
    jackton1 and jackton1 authored Dec 4, 2022

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
    Copy the full SHA
    da02d78 View commit details

Commits on Dec 5, 2022

  1. Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
    Copy the full SHA
    0c6e00a View commit details

Commits on Dec 12, 2022

  1. Copy the full SHA
    c535e45 View commit details

Commits on Dec 13, 2022

  1. Copy the full SHA
    0329f01 View commit details

Commits on Dec 15, 2022

  1. chore: update the default col max words (#378)

    Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
    jackton1 and github-actions[bot] authored Dec 15, 2022

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
    Copy the full SHA
    4749e10 View commit details
Showing with 30 additions and 13 deletions.
  1. +1 −1 .github/workflows/release.yml
  2. +1 −0 .github/workflows/sync-release-version.yml
  3. +2 −2 .github/workflows/test.yml
  4. +2 −2 .github/workflows/update-readme.yml
  5. +22 −6 HISTORY.md
  6. +1 −1 README.md
  7. +1 −1 action.yml
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -25,7 +25,7 @@ jobs:
${{ runner.os }}-go-
- name: GoReleaser
uses: goreleaser/goreleaser-action@v3
uses: goreleaser/goreleaser-action@v4
with:
version: latest
args: release --rm-dist
1 change: 1 addition & 0 deletions .github/workflows/sync-release-version.yml
Original file line number Diff line number Diff line change
@@ -29,6 +29,7 @@ jobs:
uses: peter-evans/create-pull-request@v4.2.3
with:
base: "main"
labels: "merge when passing"
title: "Upgraded to ${{ steps.sync-release-version.outputs.new_version }}"
branch: "upgrade-to-${{ steps.sync-release-version.outputs.new_version }}"
commit-message: "Upgraded from ${{ steps.sync-release-version.outputs.old_version }} -> ${{ steps.sync-release-version.outputs.new_version }}"
4 changes: 2 additions & 2 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -24,7 +24,7 @@ jobs:
${{ runner.os }}-go-
- name: GoReleaser
uses: goreleaser/goreleaser-action@v3
uses: goreleaser/goreleaser-action@v4
with:
version: latest
args: release --snapshot --rm-dist
@@ -104,7 +104,7 @@ jobs:
platform: [ubuntu-latest, windows-latest, macos-latest]
steps:
- name: Checkout
uses: actions/checkout@v3.1.0
uses: actions/checkout@v3.2.0
with:
fetch-depth: 0 # otherwise, you will failed to push refs to dest repo
persist-credentials: false # otherwise, the token used is the GITHUB_TOKEN, instead of your personal token
4 changes: 2 additions & 2 deletions .github/workflows/update-readme.yml
Original file line number Diff line number Diff line change
@@ -9,12 +9,12 @@ jobs:
sync-assets:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3.1.0
- uses: actions/checkout@v3.2.0
with:
fetch-depth: 0

- name: Run auto-doc
uses: tj-actions/auto-doc@v1.4.3
uses: tj-actions/auto-doc@v1.5.0

- name: Run test
uses: tj-actions/remark@v3
28 changes: 22 additions & 6 deletions HISTORY.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,36 @@
# Changelog

## [Unreleased](https://github.com/tj-actions/auto-doc/tree/HEAD)
## [v1.5.0](https://github.com/tj-actions/auto-doc/tree/v1.5.0) (2022-12-03)

[Full Changelog](https://github.com/tj-actions/auto-doc/compare/v1.4.3...HEAD)
[Full Changelog](https://github.com/tj-actions/auto-doc/compare/v1...v1.5.0)

## [v1](https://github.com/tj-actions/auto-doc/tree/v1) (2022-12-03)

[Full Changelog](https://github.com/tj-actions/auto-doc/compare/v1.4.3...v1)

**Closed issues:**

- Dependency Dashboard [\#2](https://github.com/tj-actions/auto-doc/issues/2)

## [v1.4.3](https://github.com/tj-actions/auto-doc/tree/v1.4.3) (2022-10-30)
**Merged pull requests:**

[Full Changelog](https://github.com/tj-actions/auto-doc/compare/v1...v1.4.3)
- chore: update test.yml [\#373](https://github.com/tj-actions/auto-doc/pull/373) ([jackton1](https://github.com/jackton1))
- feat: switch to use a temp dir [\#372](https://github.com/tj-actions/auto-doc/pull/372) ([jackton1](https://github.com/jackton1))
- Update peter-evans/create-pull-request action to v4.2.3 [\#371](https://github.com/tj-actions/auto-doc/pull/371) ([renovate[bot]](https://github.com/apps/renovate))
- Update peter-evans/create-pull-request action to v4.2.2 [\#370](https://github.com/tj-actions/auto-doc/pull/370) ([renovate[bot]](https://github.com/apps/renovate))
- Bump actions/setup-go from 2 to 3 [\#369](https://github.com/tj-actions/auto-doc/pull/369) ([dependabot[bot]](https://github.com/apps/dependabot))
- Bump actions/cache from 2 to 3 [\#368](https://github.com/tj-actions/auto-doc/pull/368) ([dependabot[bot]](https://github.com/apps/dependabot))
- Update actions/checkout action to v3 [\#367](https://github.com/tj-actions/auto-doc/pull/367) ([renovate[bot]](https://github.com/apps/renovate))
- chore: add support for coverage reporting [\#365](https://github.com/tj-actions/auto-doc/pull/365) ([jackton1](https://github.com/jackton1))
- Update peter-evans/create-pull-request action to v4.2.1 [\#363](https://github.com/tj-actions/auto-doc/pull/363) ([renovate[bot]](https://github.com/apps/renovate))
- Bump hmarr/auto-approve-action from 2 to 3 [\#362](https://github.com/tj-actions/auto-doc/pull/362) ([dependabot[bot]](https://github.com/apps/dependabot))
- chore: update test [\#361](https://github.com/tj-actions/auto-doc/pull/361) ([jackton1](https://github.com/jackton1))
- Update tj-actions/auto-doc action to v1.4.3 [\#360](https://github.com/tj-actions/auto-doc/pull/360) ([renovate[bot]](https://github.com/apps/renovate))
- Upgraded to v1.4.3 [\#359](https://github.com/tj-actions/auto-doc/pull/359) ([jackton1](https://github.com/jackton1))

## [v1](https://github.com/tj-actions/auto-doc/tree/v1) (2022-10-30)
## [v1.4.3](https://github.com/tj-actions/auto-doc/tree/v1.4.3) (2022-10-30)

[Full Changelog](https://github.com/tj-actions/auto-doc/compare/v1.4.2...v1)
[Full Changelog](https://github.com/tj-actions/auto-doc/compare/v1.4.2...v1.4.3)

**Merged pull requests:**

2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -47,7 +47,7 @@ Add the `Inputs` and/or `Outputs` [`H2` header](https://github.com/adam-p/markdo
| action | string | false | `"action.yml"` | Path to the action.yml file<br> |
| bin\_path | string | false | | Path to the auto-doc binary<br> |
| col\_max\_width | string | false | `"1000"` | Max width of a column<br> |
| col\_max\_words | string | false | `"5"` | Max number of words per<br>line in a column |
| col\_max\_words | string | false | `"7"` | Max number of words per<br>line in a column |
| input\_columns | string | false | | List of Input columns names<br>to display, default (display all<br>columns) |
| output | string | false | `"README.md"` | Path to the output file<br> |
| output\_columns | string | false | | List of Output column names<br>to display, default (display all<br>columns) |
2 changes: 1 addition & 1 deletion action.yml
Original file line number Diff line number Diff line change
@@ -13,7 +13,7 @@ inputs:
col_max_words:
description: 'Max number of words per line in a column'
required: false
default: '5'
default: '7'
output:
description: 'Path to the output file'
required: false