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

documentation publish failing #255

Merged
merged 32 commits into from
Jun 27, 2024

Conversation

shubhamparikh927
Copy link
Contributor

@shubhamparikh927 shubhamparikh927 commented Jun 24, 2024

Overview

  • Updated the release.yml to remove the unwanted CP command for angular routing

How it was tested

  • Tested the documentation publish job by temporarily updating the workflow to run on PR and commenting out npm publish job

Checklist

  • The title contains a short meaningful summary
  • I have added a link to this PR in the Jira issue
  • I have described how this was tested
  • I have included screen shots for changes that affect the user interface
  • I have updated unit tests
  • I have run unit tests locally
  • I have updated documentation (including README)

Copy link
Collaborator

@semicolin semicolin left a comment

Choose a reason for hiding this comment

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

I don't think this is the right solution. If you run a build locally and look at the dist dir, the application is now under a /browser subdir. We will need to append /browser to the paths in build-docs job.

I think the cp command is still needed. The Angular 17 documentation for deploying to GitHub pages still has this step:

  1. When the build is complete, make a copy of docs/index.html and name it docs/404.html.

@shubhamparikh927
Copy link
Contributor Author

I don't think this is the right solution. If you run a build locally and look at the dist dir, the application is now under a /browser subdir. We will need to append /browser to the paths in build-docs job.

I think the cp command is still needed. The Angular 17 documentation for deploying to GitHub pages still has this step:

  1. When the build is complete, make a copy of docs/index.html and name it docs/404.html.

I have tested it as you suggested, It's working, But now how should I have to publish the documentation as it runs on the new release. Should I have to release a new version for that?

@semicolin
Copy link
Collaborator

I don't think this is the right solution. If you run a build locally and look at the dist dir, the application is now under a /browser subdir. We will need to append /browser to the paths in build-docs job.
I think the cp command is still needed. The Angular 17 documentation for deploying to GitHub pages still has this step:

  1. When the build is complete, make a copy of docs/index.html and name it docs/404.html.

I have tested it as you suggested, It's working, But now how should I have to publish the documentation as it runs on the new release. Should I have to release a new version for that?

No need to release a new version. Just deploy it from this branch like you did before and verify that the documentation site is working.

Copy link

@shubhamparikh927 shubhamparikh927 merged commit e150f26 into main Jun 27, 2024
5 checks passed
@shubhamparikh927 shubhamparikh927 deleted the RT-1025-documentation-publish-failing branch June 27, 2024 05:29
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.

3 participants