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

Port build_directory_md from Python to Rust #473

Closed
2 of 3 tasks
cclauss opened this issue Mar 14, 2023 · 7 comments
Closed
2 of 3 tasks

Port build_directory_md from Python to Rust #473

cclauss opened this issue Mar 14, 2023 · 7 comments
Labels

Comments

@cclauss
Copy link
Member

cclauss commented Mar 14, 2023

The build_directory_md.py run in our GitHub Action directory_workflow.yml should be replaced by Rust code.

This process should be done in three separate pull requests.

  • Run both the Python and Rust versions in the same GitHub Action and fail if the two files are not identical.
  • Remove the running of the Python code in the GitHub Action and remove the Python file.
  • [Optional] Modify the Rust version to add any new information and/or look and feel.
@cclauss cclauss changed the title Rewrite Port build_directory_md from Python to Rust Mar 14, 2023
@siriak
Copy link
Member

siriak commented Mar 18, 2023

Why should we replace the existing script?

@cclauss
Copy link
Member Author

cclauss commented Mar 18, 2023

Because:

  1. It might be a change of pace for a contributor to contribute something that is not an algorithm.
  2. Learning how GitHub Actions work and how to improve them is a superpower.
  3. This community will be better able to maintain and improve code written in Rust.
  4. I may port innovations made in the new implementation back into the Python repo.

@siriak
Copy link
Member

siriak commented Mar 19, 2023

Agree, let's do it then

@github-actions
Copy link

This issue has been automatically marked as abandoned because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@siriak
Copy link
Member

siriak commented Aug 23, 2023

Let's keep this open for a while in case somebody wants to update the Rust script with new features. I can't think of any off the top of my head, but this doesn't mean there are none

@github-actions
Copy link

This issue has been automatically marked as abandoned because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@github-actions github-actions bot added the stale label Sep 23, 2023
@github-actions
Copy link

Please ping one of the maintainers once you add more information and updates here. If this is not the case and you need some help, feel free to ask for help in our Gitter channel. Thank you for your contributions!

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

No branches or pull requests

2 participants