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.7.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.7.1
Choose a head ref
  • 3 commits
  • 6 files changed
  • 4 contributors

Commits on Dec 30, 2022

  1. Upgraded from v1.6.0 -> v1.7.0

    @jackton1
    jackton1 authored Dec 30, 2022

    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
    73aa6af View commit details

  2. Merge pull request #396 from tj-actions/upgrade-to-v1.7.0 

    Upgraded to v1.7.0
    @repo-ranger
    repo-ranger[bot] authored Dec 30, 2022

    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
    51fd40f View commit details

  3. fix: bug with spacing (#397) 

    Co-authored-by: GitHub Action <action@github.com>
    @jackton1 @actions-user
    jackton1 and actions-user authored Dec 30, 2022

    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
    1fe62c4 View commit details
Showing with 158 additions and 137 deletions.
  1. +26 −4 HISTORY.md
  2. +1 −1 README.md
  3. +1 −2 cmd/root.go
  4. +51 −51 test/README-inputColumns.md
  5. +28 −28 test/README-outputColumns.md
  6. +51 −51 test/README.md
30 changes: 26 additions & 4 deletions HISTORY.md
View file
Original file line number Diff line number Diff line change
@@ -1,19 +1,41 @@
# Changelog

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

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

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

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

**Closed issues:**

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

**Merged pull requests:**

- chore/update default [\#395](https://github.com/tj-actions/auto-doc/pull/395) ([jackton1](https://github.com/jackton1))
- chore: add support to skip adding br tags to links or code [\#394](https://github.com/tj-actions/auto-doc/pull/394) ([jackton1](https://github.com/jackton1))
- chore: update the default col\_max\_words [\#393](https://github.com/tj-actions/auto-doc/pull/393) ([jackton1](https://github.com/jackton1))
- chore: add support to skip adding br tags to links or code [\#392](https://github.com/tj-actions/auto-doc/pull/392) ([jackton1](https://github.com/jackton1))
- chore: update readme [\#390](https://github.com/tj-actions/auto-doc/pull/390) ([jackton1](https://github.com/jackton1))
- chore\(deps\): update tj-actions/github-changelog-generator action to v1.17 [\#389](https://github.com/tj-actions/auto-doc/pull/389) ([renovate[bot]](https://github.com/apps/renovate))
- Updated README.md [\#388](https://github.com/tj-actions/auto-doc/pull/388) ([jackton1](https://github.com/jackton1))
- Updated README.md [\#387](https://github.com/tj-actions/auto-doc/pull/387) ([jackton1](https://github.com/jackton1))
- Updated README.md [\#386](https://github.com/tj-actions/auto-doc/pull/386) ([jackton1](https://github.com/jackton1))
- Updated README.md [\#385](https://github.com/tj-actions/auto-doc/pull/385) ([jackton1](https://github.com/jackton1))
- Updated README.md [\#384](https://github.com/tj-actions/auto-doc/pull/384) ([jackton1](https://github.com/jackton1))
- Updated README.md [\#382](https://github.com/tj-actions/auto-doc/pull/382) ([jackton1](https://github.com/jackton1))
- Update tj-actions/verify-changed-files action to v13 [\#381](https://github.com/tj-actions/auto-doc/pull/381) ([renovate[bot]](https://github.com/apps/renovate))
- Update tj-actions/auto-doc action to v1.6.0 [\#380](https://github.com/tj-actions/auto-doc/pull/380) ([renovate[bot]](https://github.com/apps/renovate))
- Upgraded to v1.6.0 [\#379](https://github.com/tj-actions/auto-doc/pull/379) ([jackton1](https://github.com/jackton1))

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

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

**Merged pull requests:**

- chore: update the default col max words [\#378](https://github.com/tj-actions/auto-doc/pull/378) ([jackton1](https://github.com/jackton1))
- Update goreleaser/goreleaser-action action to v4 [\#377](https://github.com/tj-actions/auto-doc/pull/377) ([renovate[bot]](https://github.com/apps/renovate))
- Update actions/checkout action to v3.2.0 [\#376](https://github.com/tj-actions/auto-doc/pull/376) ([renovate[bot]](https://github.com/apps/renovate))
2 changes: 1 addition & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/bb5dc10c1d2645c0894fa6774300639b)](https://app.codacy.com/gh/tj-actions/auto-doc?utm_source=github.com\&utm_medium=referral\&utm_content=tj-actions/auto-doc\&utm_campaign=Badge_Grade_Settings)
![Coverage](https://img.shields.io/badge/Coverage-82.4%25-brightgreen)
![Coverage](https://img.shields.io/badge/Coverage-82.2%25-brightgreen)
[![Go Reference](https://pkg.go.dev/badge/github.com/tj-actions/auto-doc.svg)](https://pkg.go.dev/github.com/tj-actions/auto-doc)
[![Go Report Card](https://goreportcard.com/badge/github.com/tj-actions/auto-doc)](https://goreportcard.com/report/github.com/tj-actions/auto-doc)
[![CI](https://github.com/tj-actions/auto-doc/workflows/CI/badge.svg)](https://github.com/tj-actions/auto-doc/actions?query=workflow%3ACI)
3 changes: 1 addition & 2 deletions cmd/root.go
View file
Original file line number Diff line number Diff line change
@@ -406,7 +406,6 @@ func wordWrap(s string, limit int) string {
// compile regular expressions for Markdown links and code blocks and code
linkRegex := regexp.MustCompile(`\[.*]\(.*\)`)
codeBlockRegex := regexp.MustCompile(`\` + "```" + `.*` + "```" + `\s*`)
codeRegex := regexp.MustCompile("`.*`")

// convert string to slice
strSlice := strings.Fields(s)
@@ -427,7 +426,7 @@ func wordWrap(s string, limit int) string {
if len(strSlice) < currentLimit {
currentLimit = len(strSlice)
result = result + strings.Join(strSlice[:currentLimit], " ")
} else if currentLimit == limit && !linkRegex.MatchString(strings.Join(strSlice[:currentLimit], " ")) && !codeBlockRegex.MatchString(strings.Join(strSlice[:currentLimit], " ")) && !codeRegex.MatchString(strings.Join(strSlice[:currentLimit], " ")) {
} else if currentLimit == limit && !linkRegex.MatchString(strings.Join(strSlice[:currentLimit], " ")) && !codeBlockRegex.MatchString(strings.Join(strSlice[:currentLimit], " ")) {
result = result + strings.Join(strSlice[:currentLimit], " ") + "<br>"
} else {
result = result + strings.Join(strSlice[:currentLimit], " ")
Loading