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

Added badge notice for Atom-Ink and added new badge spec #148

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions docs/reference/Admin_Actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,30 @@ When you consider that most backend services are a black box of code and decisio

With that said this document will serve as the ongoing history of administrative actions that must be taken against the backend.

## 2023 - April 15

### Uber-Juno

The [Uber-Juno](https://github.com/JunoLab/uber-juno) package uses an older unsupported coding style, sometimes called JavaScript Sloppy Mode, that's no longer supported in newer versions of NodeJS. Meaning the package crashes as soon as installed, and cannot be used without the user manually editing the source code.

Choose a reason for hiding this comment

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

as per the observation by comment pulsar-edit/pulsar#482 (comment) , it said in that error the following ...

Modules are automatically in strict mode.

and since no issues are shown after that change, I think "it uses Sloppy Mode" no longer applies...


One of the Pulsar contributors has [submitted a fix](https://github.com/JunoLab/uber-juno/pull/85) for this issue, although it has not been updated on the Pulsar Package Registry.

Choose a reason for hiding this comment

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

Suggested change
One of the Pulsar contributors has [submitted a fix](https://github.com/JunoLab/uber-juno/pull/85) for this issue, although it has not been updated on the Pulsar Package Registry.
[A fix](https://github.com/JunoLab/uber-juno/pull/85) from one of the Pulsar contributors has been merged, although it has not been updated on the Pulsar Package Registry.

Owing to the mention of "was accepted" in the section for Hydrogen (L22 in the master version)


Additionally, Uber-Juno relies on Atom-Ink, which is also broken without any fixes, as mentioned below.

Due to these issues of the package, while the `main` branch is fixed, but it relies on broken dependencies, that render's the package as a whole still broken, and in which case will receive a [`broken`](./badge-spec.md#broken) badge.
Comment on lines +15 to +17
Copy link

@goyalyashpal goyalyashpal Apr 17, 2023

Choose a reason for hiding this comment

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

Atom-Ink is also fixed.. so, this reason of "broken due to Atom-Ink" will have to be removed, and whole paragraph will have to be reworded to mention that issue with downloading as i mentioned in my previous comment:

Juno Error: Installing julia-client@0.12.6 failed as shown in the image at pulsar-edit/pulsar#482 (comment)


### Atom-Ink

The [Atom-Ink](https://github.com/JunoLab/atom-ink) package has many coding practices that are no longer valid in JavaScript/NodeJS, such as using reserved words, or using variables without declaring them first, causing the package to crash without manually being edited on Pulsar.

One of the Pulsar contributors has [submitted a fix](https://github.com/JunoLab/atom-ink/pull/289) for this bug, but after four months of inactivity from the maintainer of the package it seems unlikely this will be resolved.

The package is MIT licensed, so if any devs out there would like to pick up the reigns, and get this package functional as a fork, please feel free to do so, and you'd be encouraged to contact the Pulsar Admins about this, so we can update the badges on this package appropriately.

It is for this reason it is **not** recommended to install the `atom-ink` package. It will not work, unless you are comfortable editing the source code of the package manually, or until a community member decides to maintain a fork of said package, which in that event, installing that package would be the recommendation here, rather than not installing.
Comment on lines +21 to +27
Copy link

@goyalyashpal goyalyashpal Apr 17, 2023

Choose a reason for hiding this comment

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

This whole will have to be reworded as well... as the issue with using reserved words was with uber-juno, fix for undeclared variable use has been merged.

smth similar to instructions in line 26-28 (section hydrogen) pulsar -p install ... can work but since this is a dependency for uber-juno, i don't know what complications regarding its install that way will be...

also, the upstream hasn't tagged a release yet. so, the command will have to target a commit for the time being...

i have nudged upstream to tag it ...


With the above said, `atom-ink` will receive a [`broken`](./badge-spec.md#broken) badge.

## 2023 - March 29

Allowed for a seamless takeover of the `language-pegjs` name.
Expand Down
8 changes: 8 additions & 0 deletions docs/reference/badge-spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,3 +70,11 @@ That is, if a Pulsar users on a supported platform, indepent of any other issues
This badge would be added on a case by case basis, and would likely only be added if Pulsar users are reporting the error.

As with all other badges this badge may be removed at any time, and if you, as a package maintainer have updated a package and did not see this badge removed automatically, or within a reasonable time, feel free to [create an issue](https://github.com/pulsar-edit/package-backend/issues) asking for it to be removed.

## Broken

The `Broken` badge is used to indicate that the package available on the Pulsar Package Registry does not work at all in it's current form, on any supported platform. Either requiring manual changes to the source code, or otherwise being unrealistic to fix from the users perspective.

This package likely emits warnings immediately, or may even cause the editor to crash as a whole. Installation of these packages is not recommended by the Pulsar team, and instead it is encouraged to work with the original maintainer to get these packages working, or otherwise the community is encouraged to maintain and manage a fork of said package.

If a community member does decide to maintain a fork of a package with a `Broken` status, it's recommended to make the Pulsar Admins or Pulsar Backend Admins aware of this, so any warnings and links on the original package can be changed to recommend installation of your functional fork.
Copy link
Member

Choose a reason for hiding this comment

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

One small comment is that we don't really define Pulsar Admins or Pulsar Backend Admins anywhere, maybe we should just make this a reference to the Pulsar Team as above or otherwise recommend something like creating an issue in the backend repo?

Copy link
Member Author

Choose a reason for hiding this comment

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

This is a good point. Might make the most sense to just refer to the Pulsar Team.

Since not sure making an issue is the right move, although considering how infrequent of an event it'll be might not be that problematic.