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

Automated deploys via workflows #16

Merged
merged 5 commits into from
May 15, 2024
Merged

Conversation

brauliorivas
Copy link
Member

@brauliorivas brauliorivas commented May 10, 2024

BEGINRELEASENOTES

  • This PR is related to Preview from PRs #14.
  • Here I've added 3 possible workflows that can be used to deploy dmX.
  • All deploys will be hosted with GitHub Pages under a special branch called gh-pages. (dmX should be configured to be deployed under this branch)

This works as follows:

  1. static.yml: This will be used to deploy a stable version of dmX to GitHub Pages.
  2. preview.yml: Workflow to deploy dmX versions from PR's. That means that when opening, closing, etc, a PR, will be created a GitHub Page with that version in order to visualize the changes.
  3. development.yml: Workflow that would work with a hypothetic beta branch to deploy early/testing versions of dmX.

These workflows can also be used for #15, where some testing should run on merges/pr's.
ENDRELEASENOTES

@brauliorivas brauliorivas mentioned this pull request May 10, 2024
@brauliorivas
Copy link
Member Author

Now, the required workflows are done. After merging this, dmX repo should be configured to be deployed using GitHub Pages from a source branch. In this case: gh-pages. This process is explained in GitHub documentation here
Then, a following pull request will be opened to create an index.html file, in order to configure some redirects, as explained in here.

@brauliorivas
Copy link
Member Author

Also, I think we should configure when to run the workflows. Commonly, first-time contributors should request workflows to be run by repo owners. More about this here

@tmadlener
Copy link
Contributor

https://github.com/key4hep/dmx/pull/16/checks#step:3:164

Is this authentication error because your tokens don't have enough rights?

@brauliorivas
Copy link
Member Author

Is this authentication error because your tokens don't have enough rights?

I would think so. I think that these workflows would run successfully only if these changes are merged. Until then, they would fail. However, I'll check more about this.

@brauliorivas
Copy link
Member Author

Is this authentication error because your tokens don't have enough rights?

After checking out some documentation, I think that for this workflow to work, we need to activate read and write permissions as explained here

@tmadlener
Copy link
Contributor

I will merge this. As far as I can see all the permissions should be OK and I would like to see if this is related to not having this in the repo yet.

@tmadlener tmadlener merged commit 86328a3 into key4hep:main May 15, 2024
1 check failed
@tmadlener
Copy link
Contributor

So the preview didn't get fixed, I think (at least not for your PRs)

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.

2 participants