celestiamobile / celestia-addon-validator Goto Github PK

Swift 100.00%

celestia-addon-validator's Introduction

Upload Celestia Add-ons

Fill in the information

Go to the Update Addon page and fill in the information about this add-on you are adding, changing or removing.

You can submit add-ons by itself or signing in with an Apple ID or GitHub account. It is highly recommended to UPLOAD ADD-ONS WITH A GITHUB ACCOUNT SIGNED

After clicking the submit button, your change will be uploaded.

Submitting Addons with a GitHub Account

For GitHub submissions, two pop-up windows will appear. On its first pop-up, simply enter the title of the addon you submitted

The second pop-up window is optional. State the changes you made on the addon's update on this window. Simply click OK if it is an entirely new addon submitted

The page will then automatically create a PR for you once the two pop-up windows are successfully filled up. Proceed to Check Validation Result for the next steps

Submitting Addons with an Apple ID and/or Direct Submission

On Apple ID/Direct submissions, the screenshot below will appear. If it is successful, get the change ID.

In this example, the change ID is BAC80FE6-602D-4A39-9F54-A3FB85A2385A.

Create a pull request for validation

(NOTE: For Apple ID/Direct Submissions only)

Open this page, click Add file, then Create new file, for the file name, fill in the change ID you get earlier, leave the file content empty.

Scroll down, fill in the title and click Propose new file.

In the new page opened, click Create pull request.

Validation should begin automatically. However if it is the first time you contribute to this repository, you might need approval to get the validation started.

Check validation result

Validation should only take a few minutes.

If validation fails, it will appear like this.

Click Details, and see where it goes wrong.

In this example, title is missing in submitting a new add-on. If it fails, Click Close pull request and start from the beginning.

In a successful validation, a summary will be displayed in details.

Upload to celestia.mobi

After it passes validation, a collaborator can merge this pull request. After the pull request is merged, more checks will be performed automatically and the add-on will be uploaded to celestia.mobi.

ZIP format

GitHub does not allow uploading files to repositories directly on web. If you know how to create a pull request without web interface then create a pull request putting the zip file under pending_zip directory.

celestia-addon-validator's People

Contributors

Stargazers

Watchers

Forkers

davebowman2001 gurrenlaganntss spaceexplorer2008 anthony-b-russo10 sevenspheres coreyfqr karistus arbodox trolligi112477-ww mrspace43 galaxy-leaper1 messisuniverse cyril1992 igorxxxmirror obecito obedconag wailin247

celestia-addon-validator's Issues

Addon submission no longer works correctly

The addon submission form, signed in with GitHub, no longer shows a "Submit" button that creates a pull request. Instead, there's a "Generate" button which downloads a zip file. Presumably I could create a pull request adding this zip file to the pending_zip directory but I don't think this is the intended behavior.

News Submission 5

Continued from #77

PR creating is broken

gr2m/octokit-plugin-create-pull-request#123

Category Submissions 2

Submit a new category if a submitted addon does not properly belong to any of the existing groups on mobi

For New Categories

If a New Addon does not fit into any existing category, you can propose a new one by following the format below:

**ID:** (optional, use only for updating an existing category)
**Short Name**: (used when context about parent category is given somewhere)
**Full Name**:
**Description**:
**Parent**: (N/A if it is a root category)
**Children**: (N/A if it is a leaf category, you might want to change children's short names to be concise)
**Image**: (must be about 900 * 300 pixels in size in order for the whole image to fit)
**Add-ons**: (If it's a split category, provide a list of existing add-ons to move onto the proposed new category. Please don't forget to include their ID numbers as well)
- (Name 1 = Addon ID)
- (Name 2 = Addon ID)
- etc.

Parent Category (Example)

Full Name: Exoplanets
Description: Artistic Impressions of real exoplanets arranged by confirmation status and discovery years
Children: 0 to 9, A, B, and C, D, E and F, G, H, I and J, K, L, M and N, O, P, Q, R and S, T, U and V, W, X, Y and Z, Rogue Planets, Unconfirmed
Image:

Children Category (Example)

Short Name: Unconfirmed
Full Name: Exoplanets: Unconfirmed
Description: These addons depict the star systems whose planets were spotted but is yet to be confirmed by follow-up observations
Parent: Exoplanets
Image:

Add-ons:

82 Eridani (Unconfirmed Exoplanets) = DC7F1559-4B6F-C164-CFC1-4AE9701C322A
KOI-4878 = C1591BB3-A1C3-64D3-E817-28AFA7C63C04
KOI-5737 = FB57873D-274E-82C0-B35A-42006894FAB5
KOI-5819 = 53F67CD7-0D8F-47E0-B216-5AA844366B12
KOI-7235 = B7266580-B32B-2DFF-6785-D350E8E76001
KOI-8007 = D67545F5-9CC6-0EDF-E21B-E58BB21F3CEC
Kepler-452 = 86E1E9EC-ADF6-C370-CD40-A0C8A151F4E4
MACHO 120.22303.5389 = 8BBFAC5E-BDD9-EC1C-8647-661A8475677B
Pollux = B26ED397-40F0-4135-7337-065602E70542
TOI-709 = AAC9F87E-CDA3-9B67-FB48-E4C380B49DCB
Unconfirmed Planets = 07167CDD-7E3B-17CE-12DA-3718A6FC242B
V391 Pegasi = 3B3C7732-6D98-59DC-8FEE-A3AEA0D0FC35

There should be a way to remove a Rich Description

From Discord:

SevenSpheres: Problem with Kepler-61, the rich description wasn't updated. There should be a way to remove a rich description.
lev: Please make an issue so I can remove manually.