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

Jump to bottom

Fail build on invalid symbol links #1568

Closed
RunDevelopment opened this issue Apr 12, 2021 · 2 comments · Fixed by redpeacock78/cie.js#6
Closed

Fail build on invalid symbol links #1568

RunDevelopment opened this issue Apr 12, 2021 · 2 comments · Fixed by redpeacock78/cie.js#6
Labels
enhancement Improved functionality
Projects
Version 0.21

Comments

@RunDevelopment
Copy link
Contributor

After renaming some functions, I noticed that the documentation website contained some broken links. E.g. {@link Foo} wasn't linked because Foo got renamed and instead, the website contained the literal text "{@ link Foo}".

I searched for an option to a) get all invalid symbols and b) a way to fail the build if it contains invalid symbols so this doesn't happen again.

The --listInvalidSymbolLinks was easy enough to find but is there any way to fail the build?
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Apr 15, 2021

Currently no, there's no way to fail a build if there are warnings. I'd be open to a new treatWarningsAsErrors (or possibly other name?) option

@Gerrit0 Gerrit0 added the enhancement Improved functionality label Apr 15, 2021
@Gerrit0 Gerrit0 added good first issue Easier issue for first time contributors help wanted Contributions are especially encouraged labels Apr 23, 2021
@Gerrit0 Gerrit0 added this to To do in Version 0.21 via automation Apr 30, 2021
@Gerrit0 Gerrit0 moved this from To do to In progress in Version 0.21 May 1, 2021
@Gerrit0 Gerrit0 removed good first issue Easier issue for first time contributors help wanted Contributions are especially encouraged labels May 1, 2021
@Gerrit0 Gerrit0 moved this from In progress to Done in Version 0.21 May 1, 2021
@redpeacock78 redpeacock78 mentioned this issue Jun 18, 2021
Merged
@RunDevelopment
Copy link
Contributor Author

Thank you @Gerrit0!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement Improved functionality
Projects
No open projects
Version 0.21
Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update typedoc to the latest version redpeacock78/cie.js
2 participants
@Gerrit0 @RunDevelopment