KSP-KOS / EditorTools

Tools that make creating kOS scripts easier.
GNU General Public License v3.0
52 stars 43 forks source link

Atom package should be published for easier installation by mortals #16

Closed xeger closed 6 years ago

xeger commented 9 years ago

Hi,

I write this as "should," but in fact I did KerboScript support from scratch last night, not having encountered this repo yet, and published a package already!

The bindings in EditorTools are better thought out than my own (though I did have a couple improvements to contribute; see separate pull request). Anyhow, this ticket is more about un-forking the two independent efforts and ensuring that the package available for install in the editor's UI is the "official" one, i.e. from this repo. To this end:

  1. I've harmonized the contents of grammar.cson between the two repos (see #15).
  2. I propose that we change the suffix name to .ks or .kerboscript in the language metadata files (this being the language, as opposed to the kOS VM, runtime or addon).
  3. Having changed the suffix names in the grammar, etc, the package in this repo will be compatible with the one I've already published; I'll publish a new version from the contents of this repo, retire my own repo, and figure out if there's a way to do shared ownership in APM so someone other than myself can publish new builds of the package.

Does this sound acceptable, @space-is-hard ? If so, I'll open a PR to do the rename.

space-is-hard commented 9 years ago

Yes, absolutely! I hadn't actually tried atom until now, but it looks nice

space-is-hard commented 9 years ago

You also might find this helpful

xeger commented 9 years ago

Hmm... so, minor hitch: publishing Atom plugins requires the plugin to live in the root of its own repository.

I'd like for this repo to be owned by the KSP-KOS org. I don't mind helping to maintain it, but I'd rather keep all of the assets under one roof so I don't become a bottleneck.

So -- new plan: I make one final commit in my own repo, pointing the metadata at https://github.com/KSP-KOS/language-kerboscript -- and then transfer ownership of my repo to KSP-KOS

Does that work for you? Let me know if you'd like to choose another name for the repo (you can always rename it after I transfer it).

I looked into granting package-publication rights to others; evidently, there's no way to do it! I can keep publishing new versions for now, and I'll give you an Atom API token to use if I become unresponsive.

P.S. I've published 0.3.1 to the Atom package repository already, with our combined packages, so in some ways, there's nothing to be done -- but, might as well donate this crap to the project that caused it to happen. ;-)

erendrake commented 9 years ago

We have had a similar issue with another package manager. We could make a repo for each of the editors for the purpose of package management. and use submodules to link them back into this repo so we can centralize discussion and issue tracking?

xeger commented 9 years ago

Works for me! Just let me know what repo name you'd like to use, and I'll fix up the URLs and transfer ownership.

hvacengi commented 8 years ago

@xeger I just recently remembered that you had posted on here. I've been using your package for KS highlighting for a while. I'm gonna start posting pull requests to your repository for fixes if it's alright with you. I'd like to work on moving forward with some potential automation on the kOS side, and with bringing your package into the fold as a first class citizen.

xeger commented 8 years ago

Sounds good; I will track down the credentials I used to publish the package to atom.io and stand by for PRs.

I'm entirely happy to transfer ownership (plus atom.io creds) to the KSP-KOS org at any time.

xeger commented 8 years ago

Just a note @hvacengi that I'm going to transfer ownership of the repo to you directly. I can't transfer it to the KSP-KOS org but I believe person-to-person transfers are unrestricted. Look for .. some kind of notice ... from GitHub. I'll follow up in this thread if I encounter troubles.

xeger commented 8 years ago

Bloody hell; I can't transfer to you, because you have a fork of the same name!

Ah well; option B is to give you the Atom package-publishing credentials and delete my repo, making yours the official/canonical one. You'd want to publish a new package that points to the repo's new homepage. Let me know if that's of interest to you (and email me -- xeger at xeger dot net -- so I can transfer the creds securely).

hvacengi commented 8 years ago

I can probably just delete my fork, gimme a sec and I'll see if that works.

hvacengi commented 8 years ago

Try it now, I renamed my fork so there shouldn't be a conflict anymore.

xeger commented 8 years ago

Oh, for the love of Pete:

hvacengi already has a repository in the xeger/language-kerboscript network

​Looks like GH is out for blood and you need to delete it outright.

hvacengi commented 8 years ago

[strong bad voice]DELETED![/strong bad voice]

Try now. I find it amusing how many hoops we're jumping through, lol

xeger commented 8 years ago

Third time's the charm! You should have an offer in your inbox.

I Googled for some info on apm package ownership transfer and couldn't find anything; let me know if you encounter any trouble and I'll figure out which keys/creds you need.

On Wed, Sep 14, 2016 at 7:56 PM, Brad White notifications@github.com wrote:

[strong bad voice]DELETED![/strong bad voice]

Try now. I find it amusing how many hoops we're jumping through, lol

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/KSP-KOS/EditorTools/issues/16#issuecomment-247220222, or mute the thread https://github.com/notifications/unsubscribe-auth/AAEemDVyA73En9peHK28Vx8LI74fZjaxks5qqLPwgaJpZM4FEghF .

hvacengi commented 8 years ago

OK, according to atom.io's documentation:

If you want to hand off support of your package to someone else, you can do that by transferring the package's repository to the new owner. Once you do that, they can publish a new version with the updated repository information in the package.json.

http://flight-manual.atom.io/behind-atom/sections/maintaining-your-packages/

So, in theory, all I have to do is update package.json and then publish and I should be good to go. It doesn't even look like I should need your creds. I'll try it out later tonight.

hvacengi commented 8 years ago

(I should also mention: wait until we update that reference before you try to re-fork your own copy of the repository. Right now github is automatically redirecting to my repository, and creating a new repository with the same name would break that redirect. After package.json is updated and published we should be good to go.)

xeger commented 8 years ago

Ack; thanks for looking into it.

On Thu, Sep 15, 2016 at 7:50 AM, Brad White notifications@github.com wrote:

(I should also mention, wait until we update that reference before you try to re-fork your own copy of the repository. Right now github is automatically redirecting to my repository, and creating a new repository with the same name would break that redirect. After package.json is updated and published we should be good to go.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/KSP-KOS/EditorTools/issues/16#issuecomment-247350883, or mute the thread https://github.com/notifications/unsubscribe-auth/AAEemFYjGQHZVQQLZ60Xu3Qr0oeRekSHks5qqVs9gaJpZM4FEghF .

xeger commented 7 years ago

Hi @jim-hart; I'm standing by to help. Based on my reading of @hvacengi's message -- he owns the repo right now -- he should be able to publish APM updates himself.

If you've got better information and know that my participation is required, let me know.

jim-hart commented 7 years ago

Hi @xeger, thank you! I read over everything here and spoke with @hvacengi about the changeover. I will be closing this issue soon and have hvacengi open a similar case so I can assign him to the issue itself. I'll be sure a link to this original issue is included for reference purposes.

mathuin commented 6 years ago

Just looked into Atom support for kOS and saw two candidates -- https://atom.io/packages/language-kerboscript and https://atom.io/packages/language-kos. The former appears to be the project @xeger started -- is this still the most up-to-date option for Atom? Thanks!

jim-hart commented 6 years ago

Hi @mathuin, @hvacengi now manages the Atom package originally created by @xeger . The version available through this repository is still the older version; I believe hvacengi has been working on updates locally, so he would be your best source for its current status.

hvacengi commented 6 years ago

Now that we've pushed the most recent version of kOS, I plan on working on this issue this week.

hvacengi commented 6 years ago

Step one is done, I've successfully published a new version under my own user name.

@xeger If you so desire, you may now refork from my repository without potential for conflict. Doing a very small amount of research, I found that it looks customary to revise the MIT copyright statement for the new maintainer, but to acknowledge the previous maintainer's copyright. If you see any issues with how I modified the license file, please let me know.

Now I have to look into making sure that I can publish using APM as part of the KSP-KOS organization.

hvacengi commented 6 years ago

Looks like I successfully transfered ownership to the KSP-KOS organization. @mathuin you will now find the official atom package at the following repository: https://github.com/KSP-KOS/language-kerboscript and this atom address: https://atom.io/packages/language-kerboscript

Now @jim-hart and I can look at making appropriate updates to the package to bring it current. I would kind of like to simply grab the regex used by our compiler and make sure all of the rules are represented in the code. But I think that's a separate issue really, so I'll try to add that issue and get started on it soon. Jim if you agree that this closes this specific issue, please feel free to close the issue.

jim-hart commented 6 years ago

Sounds good @hvacengi, thanks for your continued work on this. @xeger, thank you for your original contributions and cooperation.

Issue resolved.