Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: create ERRORS.md for x/module #1059

Merged
merged 11 commits into from
Aug 9, 2023
Merged

Conversation

170210
Copy link
Contributor

@170210 170210 commented Aug 1, 2023

Description

This PR has following changes.

  • create an automatic error document generation module
  • check generated error documents in CI workflow

closes: #942

Motivation and context

How has this been tested?

Screenshots (if appropriate):

Checklist:

  • I followed the contributing guidelines and code of conduct.
  • I have added a relevant changelog to CHANGELOG.md
  • I have added tests to cover my changes.
  • I have updated the documentation accordingly.
  • I have updated API documentation client/docs/swagger-ui/swagger.yaml

@170210 170210 changed the title Feature/issue 942 docs: create ERRORS.md for x/module Aug 1, 2023
@170210 170210 self-assigned this Aug 1, 2023
@codecov
Copy link

codecov bot commented Aug 1, 2023

Codecov Report

Merging #1059 (42c625c) into main (6613064) will not change coverage.
Report is 1 commits behind head on main.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1059   +/-   ##
=======================================
  Coverage   62.02%   62.02%           
=======================================
  Files         656      656           
  Lines       78937    78937           
=======================================
  Hits        48962    48962           
  Misses      27286    27286           
  Partials     2689     2689           

Signed-off-by: 170210 <j170210@icloud.com>
Signed-off-by: 170210 <j170210@icloud.com>
Signed-off-by: 170210 <j170210@icloud.com>
Signed-off-by: 170210 <j170210@icloud.com>
Signed-off-by: 170210 <j170210@icloud.com>
@170210 170210 marked this pull request as ready for review August 1, 2023 09:31
@170210 170210 requested a review from ulbqb August 1, 2023 09:39
Signed-off-by: 170210 <j170210@icloud.com>
@ulbqb
Copy link
Member

ulbqb commented Aug 1, 2023

Please add go.mod in tools/error_doc.

@ulbqb
Copy link
Member

ulbqb commented Aug 1, 2023

How about adding link to x/ERRORS.md in x/README.md?

tools/error_doc/main.go Outdated Show resolved Hide resolved
Signed-off-by: 170210 <j170210@icloud.com>
@170210 170210 requested a review from ulbqb August 2, 2023 03:15
ulbqb
ulbqb previously approved these changes Aug 2, 2023
CHANGELOG.md Outdated Show resolved Hide resolved
Signed-off-by: 170210 <j170210@icloud.com>
zemyblue
zemyblue previously approved these changes Aug 2, 2023
ulbqb
ulbqb previously approved these changes Aug 2, 2023
@170210 170210 marked this pull request as draft August 3, 2023 06:03
Signed-off-by: 170210 <j170210@icloud.com>
@170210 170210 marked this pull request as ready for review August 7, 2023 03:06
Copy link
Member

@tnasu tnasu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about renaming the file to error_docs_generator.go?

Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
tools/error_doc/generator/errors_file_parser.go Outdated Show resolved Hide resolved
tools/error_doc/generator/module_directory_walker.go Outdated Show resolved Hide resolved
Signed-off-by: 170210 <j170210@icloud.com>
ulbqb
ulbqb previously approved these changes Aug 8, 2023
Copy link
Member

@ulbqb ulbqb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Signed-off-by: 170210 <j170210@icloud.com>
@170210 170210 merged commit ba75f8e into Finschia:main Aug 9, 2023
37 checks passed
zemyblue added a commit to zemyblue/finschia-sdk that referenced this pull request Oct 17, 2023
* main:
  chore(deps): Bump github.com/prometheus/client_golang (Finschia#1132)
  feat: add update-censorship cmd to x/foundation cli (Finschia#1121)
  chore(deps): Bump actions/checkout from 3 to 4 (Finschia#1110)
  chore(deps): Bump actions/cache from 3.3.1 to 3.3.2 (Finschia#1119)
  chore(deps): Bump docker/build-push-action from 4 to 5 (Finschia#1123)
  chore(deps): Bump docker/login-action from 2 to 3 (Finschia#1124)
  chore(deps): Bump docker/metadata-action from 4 to 5 (Finschia#1125)
  chore(deps): Bump github.com/hashicorp/golang-lru from 0.5.5-0.20210104140557-80c98217689d to 1.0.2 (Finschia#1074)
  chore(deps): Bump github.com/go-kit/kit from 0.12.0 to 0.13.0 (Finschia#1097)
  chore(deps): Bump golang.org/x/crypto from 0.11.0 to 0.13.0 (Finschia#1111)
  chore: fix tag comments in github actions workflow docker.yml (Finschia#1078)
  docs: update links in x/foundation README.md (Finschia#1120)
  docs: create ERRORS.md for x/module (Finschia#1059)

# Conflicts:
#	CHANGELOG.md
#	Makefile
#	go.mod
#	go.sum
jaeseung-bae pushed a commit to jaeseung-bae/finschia-sdk that referenced this pull request May 7, 2024
* chore: create an automatic error document generation module

Signed-off-by: 170210 <j170210@icloud.com>

* docs: generate ERRORS.md for x/module

Signed-off-by: 170210 <j170210@icloud.com>

* chore: add a ci to check generated error docs up-to-date

Signed-off-by: 170210 <j170210@icloud.com>

* chore: update changelog

Signed-off-by: 170210 <j170210@icloud.com>

* refactor: fix for lint

Signed-off-by: 170210 <j170210@icloud.com>

* style: format yml file

Signed-off-by: 170210 <j170210@icloud.com>

* fixup: fix for review

Signed-off-by: 170210 <j170210@icloud.com>

* fixup: fix for review

Signed-off-by: 170210 <j170210@icloud.com>

* fixup: refactor by comment

Signed-off-by: 170210 <j170210@icloud.com>

* fixup: fix for comment

Signed-off-by: 170210 <j170210@icloud.com>

* fixup: fix for comment

Signed-off-by: 170210 <j170210@icloud.com>

---------

Signed-off-by: 170210 <j170210@icloud.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add the error document for all module
4 participants