• Uploading a new Package
• Managing Package Versions

Package Management (on-site)

Welcome to our Package Management Documentation! This guide provides comprehensive information on creating and managing packages on our platform.

Uploading a new Package

In this section, you'll learn how to create and upload a new package to our platform. Follow the steps below to get started:

1. Step 1: Preparation

   • Gather all necessary files and documentation for your package.

2. Step 2: Upload Files

   • Upload the files and assets associated with your package.

3. Step 3: Review and Submit

   • Review the package details and files.
   • Submit your package for review and publication.

Preparation

Before you start creating and uploading your package, you will need to make sure your package has all the necessary files within its directory. This is how your package's file structure should look:

higitusfigitus/
├── package.json
├── README.md
├── CHANGELOG.md
├── ... (Other Files and Folders)

Note: If you are unfamiliar with the package.json file, this file contains all of your package's information, name, version etc. More information about this can be found on the package.json documentation page.

README.md and CHANGELOG.md files

Both of these files can contain Markdown content. Your README content is shown on the overview page of your package, and the CHANGELOG content can be viewed per version. More information about the documentation files can be found here.

Upload Files

To upload your package files and assets, follow these steps:

1. Log in to your platform account.
2. Navigate to the package upload section.
3. Click the "Upload" button.
4. Select the .ZIP file of your package's directory.

Review and Submit

After uploading your package files, it's essential to review and submit your package for approval:

1. Double-check all package details and files for accuracy.
2. Make any necessary edits or adjustments.
3. Once you're satisfied with your package, click the "Submit" button.
4. Your package will undergo a review process before publication. You'll receive notifications regarding the status.

Managing Package Versions

Handling versions of your package is pretty straightforward, but it's crucial to ensure continuity and consistency for your package's users. Below is the process for uploading a new version of your existing package:

1. Step 1: Preparation

   • Ensure your package files, especially package.json, are updated for the new version.

2. Step 2: Uploading the New Version

   • Upload the updated package as a new version.

3. Step 3: Review and Submit Version

   • Go over the version details and then submit your new version.

Preparation for the New Version

The foundation for any version update starts with updating your files:

• Update package.json: Ensure that the version number in your package.json file reflects the new version. This number should, of course, be higher than the previous version.
• Consistency is Key: Make sure the package name and author name remain unchanged in the package.json file. This ensures continuity for your package across different versions.

Uploading the New Version

Adding a new version to an existing package is quite similar to adding a new package, just with a few tweaks:

1. Log in to your platform account.
2. Head over to "Account" > "Your Packages". This section showcases a list of all your uploaded packages.
3. Find Your Package: Scan through your package list and find the one you want to update.
4. Click on the "Add version" icon to proceed to the version addition page.
5. Much like when you're adding a new package, here you'll be prompted to upload a .ZIP file containing the files for your new version.

Review and Submit the New Version

After you've uploaded the new version's files, it's time for a final review:

1. Quality Check: Go over all version details and ensure everything is accurate and consistent with previous versions.
2. If there are any mistakes or adjustments needed, now's the time to sort them out.
3. Once everything looks top-notch, hit that "Submit" button.