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

Update docs to match new major release breaking changes #1655

Closed
wants to merge 15 commits into from

Conversation

SferaDev
Copy link
Contributor

@SferaDev SferaDev commented Nov 24, 2021

Requires:

Changes:

  • Use new rule on md/mdx code snippets
  • Update docs with new rule changes and minor prettier updates

Screenshots

Please provide before/after screenshots for any visual changes

Merge checklist

  • Added/updated tests
  • Added/updated documentation
  • Tested in Chrome
  • Tested in Firefox
  • Tested in Safari
  • Tested in Edge

Take a look at the What we look for in reviews section of the contributing guidelines for more information on how we review PRs.

@changeset-bot
Copy link

changeset-bot bot commented Nov 24, 2021

⚠️ No Changeset found

Latest commit: ca7fff6

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@SferaDev SferaDev marked this pull request as ready for review November 24, 2021 12:47
@SferaDev SferaDev requested review from a team and rezrah November 24, 2021 12:47
@SferaDev
Copy link
Contributor Author

I noticed this for StyledOcticon but actually there're lots of outdated examples after #1639

@SferaDev SferaDev marked this pull request as draft November 24, 2021 12:53
Copy link
Member

@siddharthkp siddharthkp left a comment

Choose a reason for hiding this comment

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

Yes! Love to see it

@siddharthkp siddharthkp added the skip changeset This change does not need a changelog label Nov 24, 2021
@SferaDev
Copy link
Contributor Author

@siddharthkp Not sure if other props should be migrated, and/or if there's a linter rule to warn about this breaking change for the next major

@siddharthkp
Copy link
Member

@SferaDev eslint-plugin-primer-react has a new release to go with the major version: https://github.com/primer/eslint-plugin-primer-react/releases

Copy link
Contributor

@colebemis colebemis left a comment

Choose a reason for hiding this comment

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

Thank you ✨

@SferaDev
Copy link
Contributor Author

SferaDev commented Nov 25, 2021

@SferaDev eslint-plugin-primer-react has a new release to go with the major version: primer/eslint-plugin-primer-react/releases

The linter is not catching these, ie: the mr on the same file.

Signed-off-by: Alexis Rico <sferadev@gmail.com>
@SferaDev
Copy link
Contributor Author

Created primer/eslint-plugin-primer-react#21 to allow the rule to be executed on the code snippets from docs folder.

cc: @jfuchs

Signed-off-by: Alexis Rico <sferadev@gmail.com>
Signed-off-by: Alexis Rico <sferadev@gmail.com>
Signed-off-by: Alexis Rico <sferadev@gmail.com>
@SferaDev SferaDev marked this pull request as ready for review November 25, 2021 13:02
@SferaDev SferaDev changed the title Update Octicon docs Update docs to match new major release breaking changes Nov 25, 2021
@mperrotti
Copy link
Contributor

@SferaDev - could we get the conflicts resolved so we can merge this?

@SferaDev
Copy link
Contributor Author

Sure thing, will update tomorrow

Signed-off-by: Alexis Rico <sferadev@gmail.com>
Signed-off-by: Alexis Rico <sferadev@gmail.com>
@SferaDev
Copy link
Contributor Author

SferaDev commented Jan 12, 2022

@SferaDev - could we get the conflicts resolved so we can merge this?

Done! @mperrotti, however keep in mind that it requires primer/eslint-plugin-primer-react#21

Actually this PR is nothing else than running lint --fix and prettier with that fix to the eslint plugin

PS: I've reverted the changes for the files on the drafts folder, I guess they will need to be excluded on the plugin rule too, but not sure if the prop spec is finalized.

Signed-off-by: Alexis Rico <sferadev@gmail.com>
Signed-off-by: Alexis Rico <sferadev@gmail.com>
Signed-off-by: Alexis Rico <sferadev@gmail.com>
@github-actions
Copy link
Contributor

Hi! This pull request has been marked as stale because it has been open with no activity for 60 days. You can comment on the pull request or remove the stale label to keep it open. If you do nothing, this pull request will be closed in 7 days.

@github-actions github-actions bot added the Stale label Mar 13, 2022
@github-actions github-actions bot closed this Mar 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip changeset This change does not need a changelog Stale
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants