Skip to content
This repository has been archived by the owner on Nov 13, 2022. It is now read-only.

[Please Review] Automated Upgrade Of fastpages Template #143

Merged
merged 9 commits into from
Mar 3, 2020

Conversation

hamelsmu
Copy link
Member

@hamelsmu hamelsmu commented Feb 29, 2020

Summary of Changes

  1. Moved various files under _fastpages_docs in order to make the repo more organized, there was too many files in the root.

  2. Setup A Mechanism To Automatically Upgrade The Repository.

  • An automated experience is only possible at the moment when users do not customize the styling and HTML of their site. When users customize HTML or CSS, there is no guarantee that a new version of fastpages will not collide with the customization.

Overview of Automated Steps

Step 1: Open Issue

Users will be able to open an issue from this issue template:

image

Step 2: Wait 15 Seconds For Issue Comment

The user must not edit the title of the Issue, and proceed to opening the issue from the above template. When the issue is opened, a Pull Request is triggered that fetches the latest version of a subset of fastpages files ( basically everything except certain config files and blog post content ).

Actions then makes a comment with a link to the PR in the issue:

image

Step 3: Navigate to the PR

The user is presented with a PR that looks like this

image

Step 4: Review the PR and Merge


Things I would appreciate a review on

@jph00 @xnutsive

  1. Does the flow make sense?
  2. Please read the messaging in the PR, does that seem ok? You can find the language in this pr in the file _upgrade_pr.md
  3. Please provide any other suggestions and feedback.

Some notes: This is far easier than trying to merge upstream changes into your template because:

  • I am strategically copying only certain files, thus minimizing the chance for conflicts.
  • If you do this yourself the commit histories are not related, so you have to jump through advanced git hoops yourself to make this work.
  • As mentioned above, this only works well if users don't customize the styling and HTML of their pages.

Feedback is very appreciated.

@hamelsmu
Copy link
Member Author

This PR closes #77

@hamelsmu hamelsmu changed the title provide auto upgrade path [Please Review] Automated Upgrade Of fastpages Template Mar 2, 2020
@hamelsmu hamelsmu linked an issue Mar 2, 2020 that may be closed by this pull request
@hamelsmu
Copy link
Member Author

hamelsmu commented Mar 3, 2020

I'm going to go ahead and merge this so I can test this ( I can only do so much testing on a branch )

@hamelsmu
Copy link
Member Author

hamelsmu commented Mar 3, 2020

/preview

@github-actions github-actions bot added the draft build pending Indicates that a preview of your site is being built from your PR label Mar 3, 2020
@github-actions
Copy link

github-actions bot commented Mar 3, 2020

A preview build of this branch has been generated for SHA: e8eab5a and can be viewed live at: https://5e5da08776d0af018880e1c2--fastpages.netlify.com

The current fastpages site built from master can be viewed for comparison here

@github-actions github-actions bot removed the draft build pending Indicates that a preview of your site is being built from your PR label Mar 3, 2020
@hamelsmu hamelsmu merged commit 1989300 into master Mar 3, 2020
@hamelsmu hamelsmu deleted the auto-upgrade branch March 3, 2020 00:17
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Provide users with a path to automated upgrade
1 participant