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 necessary files #3

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Add necessary files #3

wants to merge 7 commits into from

Conversation

ydah
Copy link
Member

@ydah ydah commented Jan 9, 2024

This PR prepared the necessary files with reference to https://github.com/rubocop/ruby-style-guide .

@ydah ydah requested a review from a team January 9, 2024 11:28
@ydah ydah changed the title Prepare necessary files Add necessary files Jan 9, 2024
.circleci/config.yml Outdated Show resolved Hide resolved
.circleci/config.yml Outdated Show resolved Hide resolved
Copy link

@bquorning bquorning left a comment

Choose a reason for hiding this comment

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

I wonder if it wouldn’t be easier to build the gh-pages from GitHub Actions instead of setting it up in Circle CI?

.circleci/config.yml Outdated Show resolved Hide resolved
.circleci/config.yml Outdated Show resolved Hide resolved
@ydah
Copy link
Member Author

ydah commented Jan 9, 2024

I wonder if it wouldn’t be easier to build the gh-pages from GitHub Actions instead of setting it up in Circle CI?

Once I brought it from another style-guide repository, I thought that improvements could be made later, so I copied it once. OK, I will rewrite it in GHA.

@ydah
Copy link
Member Author

ydah commented Jan 11, 2024

The deployment mechanism was created in GHA with the assumption that the following settings would be made
Generate documents by asciidoctor under docs/ at the timing of push to main. If there is any change, push the change to main. What do you think?
screenshot

@ydah
Copy link
Member Author

ydah commented Jan 11, 2024

Tested in another repository:
https://github.com/ydah/capybara-style-guide/actions/runs/7486787282/job/20377842663

The following commits were pushed:
ydah@8e50673

@timdiggins
Copy link
Collaborator

The deployment mechanism was created in GHA with the assumption that the following settings would be made
Generate documents by asciidoctor under docs/ at the timing of push to main. If there is any change, push the change to main. What do you think?

The other mechanism (the only one I've used before) is to (force)push to gh-pages branch. The advantage of this is that if for some reason some manual (emergency) tweaks are required they can be done.

If this mechanism (pushing to $GITHUB_REF, which I think will be main?) runs when there's a push to main and also pushes to main, it may be that we can't do any manual changes (will github not get stuck in a loop of github actions?)

Sorry I'm a gh actions newbie so I might be on the wrong track

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.

4 participants