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

document CI/CD and Next.js quirks #187

Closed
advaithg opened this issue Jun 29, 2021 · 0 comments · Fixed by #198
Closed

document CI/CD and Next.js quirks #187

advaithg opened this issue Jun 29, 2021 · 0 comments · Fixed by #198
Assignees

Comments

@advaithg
Copy link
Contributor

The current README is incomplete, with a TODO in the place of "Production Deploy"

To fix this, write documentation for the new CI/CD pipeline, and also describe some of the weird quirks with next.js for future devs (mainly next/image)

mattxwang added a commit that referenced this issue Jul 7, 2021
While working on #187, I noticed that we "waste" a bit of Actions time rebuilding, linting, and running CodeQL against PRs that only introduce changes to `README.md`. Since we aren't using a markdown linter like `remark`, these Actions are all going to be a no-op.

So, this PR disables these actions on commits that only change `README.md`. If this is useful, we may want to:

* expand the set of files that we don't run changes against
* push this change upstream to other react projects we use, particularly the react starters that Teach LA uses
advaithg added a commit that referenced this issue Jul 8, 2021
* Bump eslint-config-next from 11.0.0 to 11.0.1 (#196)

Bumps [eslint-config-next](https://github.com/vercel/next.js/tree/HEAD/packages/eslint-config-next) from 11.0.0 to 11.0.1.
- [Release notes](https://github.com/vercel/next.js/releases)
- [Changelog](https://github.com/vercel/next.js/blob/canary/release.js)
- [Commits](https://github.com/vercel/next.js/commits/v11.0.1/packages/eslint-config-next)

---
updated-dependencies:
- dependency-name: eslint-config-next
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump next from 11.0.0 to 11.0.1 (#197)

Bumps [next](https://github.com/vercel/next.js) from 11.0.0 to 11.0.1.
- [Release notes](https://github.com/vercel/next.js/releases)
- [Changelog](https://github.com/vercel/next.js/blob/canary/release.js)
- [Commits](vercel/next.js@v11.0.0...v11.0.1)

---
updated-dependencies:
- dependency-name: next
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump eslint from 7.29.0 to 7.30.0 (#195)

Bumps [eslint](https://github.com/eslint/eslint) from 7.29.0 to 7.30.0.
- [Release notes](https://github.com/eslint/eslint/releases)
- [Changelog](https://github.com/eslint/eslint/blob/master/CHANGELOG.md)
- [Commits](eslint/eslint@v7.29.0...v7.30.0)

---
updated-dependencies:
- dependency-name: eslint
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore: ignores README-only changes for actions triggers (#199)

While working on #187, I noticed that we "waste" a bit of Actions time rebuilding, linting, and running CodeQL against PRs that only introduce changes to `README.md`. Since we aren't using a markdown linter like `remark`, these Actions are all going to be a no-op.

So, this PR disables these actions on commits that only change `README.md`. If this is useful, we may want to:

* expand the set of files that we don't run changes against
* push this change upstream to other react projects we use, particularly the react starters that Teach LA uses

* converts about page

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Matt Wang <matt@matthewwang.me>
mattxwang added a commit that referenced this issue Jul 9, 2021
…r corrections (#198)

I want to preface this by saying that I'm planning on rescoping #187 and adding a follow-up issue.

In this PR, I address parts of the original spirit of #187:

* documenting the prod CD pipeline
* updating relevant portions of the docs to be *more correct*
* adding a licensing/attribution section
* adds TOC

I want to move the discussion around Next.js, as well as the general design choices, to a project design document not unlike the one for [Creative Lab's website](https://github.com/UCLA-Creative-Labs/sunshine/blob/master/DESIGN_GUIDELINES.md). More in #202.

closes #187.
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 a pull request may close this issue.

2 participants