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

Add a CI workflow to build trunk-support on trunk #410

Merged
merged 2 commits into from
Apr 3, 2023

Conversation

shym
Copy link
Contributor

@shym shym commented Apr 3, 2023

This PR adds a CI workflow to build trunk-support on the latest trunk once a day and on updates on that branch. It also adds a badge to the README (hopefully I got those URLs right 🤔), which might help maintain the branch; and help users check whether possible issues were detected already.

shym added 2 commits April 3, 2023 14:21
Test whether `trunk-support` build on the `trunk` compiler once a day
and on pushes and pull requests

Signed-off-by: Samuel Hym <[email protected]>
Signed-off-by: Samuel Hym <[email protected]>
Copy link
Member

@pitag-ha pitag-ha left a comment

Choose a reason for hiding this comment

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

Nice, thank you, @shym!

I'm not sure about the badge either. The best way to find out is to merge and see.

Comment on lines +7 to +8
# Every weekday, at 5:43 UTC
- cron: '43 5 * * 1-5'
Copy link
Member

Choose a reason for hiding this comment

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

I love the time you've chosen for the run!

Comment on lines +3 to +4
[![Build on `trunk`](https://github.com/ocaml-ppx/ppxlib/actions/workflows/build.yml/badge.svg?branch=trunk-support)](https://github.com/ocaml-ppx/ppxlib/actions/workflows/build.yml)

Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure either here. I was expecting something like

[![Build on `trunk`](https://img.shields.io/github/workflow/status//ocaml-ppx/ppxlib/
<I don't know what>?branch=trunk-support)](https://github.com/ocaml-ppx/ppxlib/
actions/workflows/build.yml)

Let's merge what you've put and see if it works!

Copy link
Member

Choose a reason for hiding this comment

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

To follow up on this: It works! 🎉

@pitag-ha pitag-ha merged commit 3b6c085 into ocaml-ppx:trunk-support Apr 3, 2023
@marrious11
Copy link
Contributor

Hello @pitag-ha, I was looking at the CHANGES.me file.
Would it be nice to make the @mention user and #... issues as links?
For instance:

Instead of just:

  • Allow users to vendor ppxlib as-is, as well as ppx_sexp_conv in the same project (#... issues, @mention user),
    which is not a link that can redirect one into the stated issue number easily

@marrious11
Copy link
Contributor

@pitag-ha, my reason for this suggestion is that, if someone visits the CHANGES.me file, they should be able to see a summary of the status(merged, open, failed, etc.) for that particular issue.
Let me know what you think about it, please!

@shym shym deleted the trunk-ci branch April 4, 2023 07:00
@pitag-ha
Copy link
Member

pitag-ha commented Apr 4, 2023

Hi @marrious11, thanks for the suggestion! That's a good idea and, in fact, it's already the case. Let me explain. The purpose of the CHANGES.md is to generate the release notes when releasing ppxlib. You can have a look at our release notes here, where you can see that the PR tags automatically serve as links to the PRs.

Btw, just so you know: Outreachy applicants aren't expected to keep on working on the projects once the contribution period is over. And any contributions you do now, won't be taken into account in the intern selection process. Also, we don't want to take advantage of applicants working more on our projects than expected. That being said, if you'd love to keep on working on ppxlib/PPXs out of interest and to learn more, you're welcome to do so. I just wanted to be clear that it would only be for you to grow, not for the Outreachy process.

@marrious11
Copy link
Contributor

Wow, @pitag-ha 🥲 I saw the release notes, they were awesome more than even what I thought it to be.



About Outreachy:
Yes, actually about contribution is over, I just wish to learn more and acquire software development skills in functional Programming with Ocaml. I believe that here in the community I will be able to learn as much as to prepare me to contribute professionally back to the community.

With the Ocaml community:

  1. I believe to gain technical level experience in understanding of software engineering standard methodologies such as;
  • Issues resolution

  • Understanding large codebases

  • code maintainability,

  • code review, automated testing,

  • continuous integration.

  • and More...
    Please let me know if I can archive them here with the community!

@pitag-ha
Copy link
Member

pitag-ha commented Apr 5, 2023

Hey @marrious11, I've just moved our conversation over to the issue dedicated to Outreachy-related things and have answered your questions there.

NathanReb added a commit to NathanReb/ppxlib that referenced this pull request Jun 12, 2024
Adds an action that builds with the latest supported trunk.

I heavily reused the work of @shym from ocaml-ppx#410, thank you for this
contribution!

Signed-off-by: Nathan Rebours <[email protected]>
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