You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on Mar 3, 2023. It is now read-only.
This issue tracks the steps necessary to migrate the autoflow package into the core atom/atom repository under the packages path:
Migration Checklist
Phase 1 - Prepare repo for migration
Merge or close existing pull requests on the atom/autoflow repository
Some guidelines for merging vs closing PRs:
Merge when the PR is small, useful, has no merge conflicts with master, and has passing tests
Close when the changes are non-trivial, the PR has conflicts with master, or there are failing tests in CI
If you close a PR, let the user know that we are currently moving the repository over to atom/atom so they should feel free to reopen the pull request there once the package code has been migrated.
Phase 2 - Migrate the package code
Create a fresh branch off master in your local clone of atom/atom with the name migrate-autoflow-package
Delete Atom's node_modules folder if you've built there before and make sure Atom's package-lock.json file is unmodified
Clone the atom/autoflow repo into the packages path of your local Atom repository and then delete its .git subfolder
Delete any unnecessary repo configuration files in the packages/autoflow folder like appveyor.yml, .travis.yml, ISSUE_TEMPLATE.md, and PULL_REQUEST_TEMPLATE.md
Remove any information from the package's README.md which will be inaccurate after the migration is complete (e.g. CI status badges or contribution instructions)
Edit Atom's package.json file to change the autoflow entry in packageDependencies to reflect the local path of the package:
"autoflow": "file:./packages/autoflow",
Delete the autoflow entry in package.json's dependencies section since it may contain a hardcoded tarball link. This will help avoid issues in the next step
Run a full Atom build using script/build and verify that there are no unexpected build errors
Launch the Atom binary in the ./out folder and manually verify that the migrated package is working without any obvious issues. For example, if you're migrating a color theme, turn on that theme to make sure that it changes the editor colors as expected.
Open the Chrome Developer Tools console (Ctrl+Shift+I or Cmd+Option+I) and ensure that there are no errors written there. If there are, add them to this issue and investigate.
Update the second column of the autoflow row in packages/README.md to reflect the new local path for the package:
[`./packages/autoflow`](./autoflow)
Commit the migrated package code and any changes to Atom's package-lock.json files to your branch using this commit message:
:arrow_right: Migrate core package 'autoflow' into ./packages
Phase 3 - Make sure the package works and send a PR
Run the full suite of Atom tests with script/test and verify that they pass locally
If any tests fail, investigate and fix them then commit the fixes to your branch
Create a PR against atom/atom to verify that CI passes
Add a label titled packages/autoflow to the migrated issues so that they can be found easily
Edit the original package repo's README.md (don't commit directly) to point contributors to the code's new home in atom/atom. You can use the following text:
### This package is now a part of the [core Atom repository](https://github.com/atom/atom/tree/master/packages/autoflow), please direct all issues and pull requests there in the future!
---
Send a PR to the autoflow repository with the updated README.md so that watchers will be notified of the change. You do not need to wait for reviews, it can be merged immediately.
Archive the package repository by going to its Settings page, scroll down to the "Danger Zone" section and click "Archive this Repository"
Migration is now complete! 🎉
The text was updated successfully, but these errors were encountered:
This issue has been automatically locked since there has not been any recent activity after it was closed. If you can still reproduce this issue in Safe Mode then please open a new issue and fill out the entire issue template to ensure that we have enough information to address your issue. Thanks!
lockbot
locked as resolved and limited conversation to collaborators
Mar 10, 2019
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.
This issue tracks the steps necessary to migrate the
autoflow
package into the coreatom/atom
repository under thepackages
path:Migration Checklist
Phase 1 - Prepare repo for migration
atom/autoflow
repositorySome guidelines for merging vs closing PRs:
master
, and has passing testsmaster
, or there are failing tests in CIIf you close a PR, let the user know that we are currently moving the repository over to
atom/atom
so they should feel free to reopen the pull request there once the package code has been migrated.Phase 2 - Migrate the package code
master
in your local clone ofatom/atom
with the namemigrate-autoflow-package
node_modules
folder if you've built there before and make sure Atom'spackage-lock.json
file is unmodifiedatom/autoflow
repo into thepackages
path of your local Atom repository and then delete its.git
subfolderpackages/autoflow
folder likeappveyor.yml
,.travis.yml
,ISSUE_TEMPLATE.md
, andPULL_REQUEST_TEMPLATE.md
README.md
which will be inaccurate after the migration is complete (e.g. CI status badges or contribution instructions)package.json
file to change theautoflow
entry inpackageDependencies
to reflect the local path of the package:autoflow
entry inpackage.json
'sdependencies
section since it may contain a hardcoded tarball link. This will help avoid issues in the next stepscript/build
and verify that there are no unexpected build errors./out
folder and manually verify that the migrated package is working without any obvious issues. For example, if you're migrating a color theme, turn on that theme to make sure that it changes the editor colors as expected.packages/README.md
to reflect the new local path for the package:package-lock.json
files to your branch using this commit message:Phase 3 - Make sure the package works and send a PR
script/test
and verify that they pass locallyatom/atom
to verify that CI passesPhase 4 - Archive the
autoflow
repoautoflow
repo toatom/atom
using github-issue-mover or a scriptpackages/autoflow
to the migrated issues so that they can be found easilyatom/atom
. You can use the following text:autoflow
repository with the updated README.md so that watchers will be notified of the change. You do not need to wait for reviews, it can be merged immediately.Migration is now complete! 🎉
The text was updated successfully, but these errors were encountered: