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

Fix : Compatibility issues with Doxygen version in runner and configuration #4732

Merged
merged 15 commits into from
Jun 19, 2024

Conversation

AdarshRawat1
Copy link
Member

Impact

Fix the output generated by deploy workflow

run: sudo apt-get install doxygen graphviz -y
shell: bash
- name: Install Custom Doxygen Version
uses: AdarshRawat1/Install-Doxygen@v1.0
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is your own action? Neat. However, for maintenance reasons it might be easier to just inline this particular installation.

Copy link
Member Author

@AdarshRawat1 AdarshRawat1 Jun 18, 2024

Choose a reason for hiding this comment

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

This is your own action? Neat.

Yes ! Thanks

However, for maintenance reasons it might be easier to just inline this particular installation.

Sure, I'll do that !!

However this action is responsible only for installating particular version of doxygen being passed, and it would be cleaner this way. (We can simply update the version being passed.)

That is the reason I thought it would be better to have a custom action.

Copy link
Member Author

Choose a reason for hiding this comment

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

As there isn't much that we'll have to maintain here other than the version.

Copy link
Collaborator

Choose a reason for hiding this comment

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

The main reason for inlining is that we maintain the installation directly here in P4C whereas with the other approach we have to depend on an external action we do not necessarily own.

Copy link
Member Author

Choose a reason for hiding this comment

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

Sure thing !

@fruffy fruffy added the documentation Topics related to compiler documentation. label Jun 18, 2024
@fruffy fruffy enabled auto-merge June 19, 2024 15:45
auto-merge was automatically disabled June 19, 2024 15:47

Head branch was pushed to by a user without write access

@fruffy fruffy enabled auto-merge June 19, 2024 16:00
@fruffy fruffy added this pull request to the merge queue Jun 19, 2024
Merged via the queue into p4lang:main with commit ef0657a Jun 19, 2024
16 checks passed
@jafingerhut
Copy link
Contributor

Is there any difference in information published to P4.org public pages, or any p4lang projects, as a result of these changes? If so, what links could I look at to see the results?

Or perhaps these changes require running Doxygen on one's local system?

@fruffy
Copy link
Collaborator

fruffy commented Jun 19, 2024

Is there any difference in information published to P4.org public pages, or any p4lang projects, as a result of these changes? If so, what links could I look at to see the results?

Or perhaps these changes require running Doxygen on one's local system?

https://p4lang.github.io/p4c/pages.html

The page is still work in progress.

@AdarshRawat1 AdarshRawat1 deleted the dev-doxygen-workflow branch June 20, 2024 05:39
@AdarshRawat1
Copy link
Member Author

Or perhaps these changes require running Doxygen on one's local system?

Initially, there was this requirement of running the Doxygen locally.
However, the recent setup of the GitHub workflow, automatically deploys Doxygen generated docs to gh-pages branch [configured for GitHub pages].
Ensuring that the latest changes will now be reflected directly on the documentation page for each new commit on main branch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Topics related to compiler documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants