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

Add SkipTo plugin #1317

Merged
merged 1 commit into from
Aug 28, 2024
Merged

Add SkipTo plugin #1317

merged 1 commit into from
Aug 28, 2024

Conversation

awe-source
Copy link

Plugin to start printing at a specified layer.

@jneilliii
Copy link
Contributor

@awe-source I see only two issues with your plugin that needs to be addressed before release. First your software update hook needs to return the exact same name as your plugin_identifier here: https://github.com/awe-source/OctoPrint-SkipTo/blob/master/octoprint_skipto/__init__.py#L76. skipTo should be SkipTo. Once that change is made on your repo, then you'll need to create a release and tag that matches the version number configured in setup.py (0.1.0) here: https://github.com/awe-source/OctoPrint-SkipTo/releases. Once those two things are addressed comment back here and let me know and I can move forward with the process.

@awe-source
Copy link
Author

Have, hopefully, made the correct changes

@jneilliii
Copy link
Contributor

It looks like the software update hook may still be off. Should be like this:

    def get_update_information(self):
        # Define the configuration for your plugin to use with the Software Update
        # Plugin here. See https://docs.octoprint.org/en/master/bundledplugins/softwareupdate.html
        # for details.
        return {
            "SkipTo": {
                "displayName": "SkipTo",
                "displayVersion": self._plugin_version,

                # version check: github repository
                "type": "github_release",
                "user": "awe-source",
                "repo": "OctoPrint-SkipTo",
                "current": self._plugin_version,

                # update method: pip
                "pip": "https://github.com/awe-source/OctoPrint-skipTo/archive/{target_version}.zip",
            }
        }

@awe-source
Copy link
Author

Fixed?

@jneilliii
Copy link
Contributor

Yes, that looks good, thanks.

@jneilliii jneilliii merged commit cdebc2c into OctoPrint:gh-pages Aug 28, 2024
4 checks passed
@awe-source
Copy link
Author

awe-source commented Aug 28, 2024

Um do I need to recreate the release?
Never mind- yes I do…

@awe-source
Copy link
Author

awe-source commented Sep 9, 2024 via email

@cp2004
Copy link
Member

cp2004 commented Sep 9, 2024

No stats sometimes means there's a mismatch in plugin ids. Your plugin ID should be the same as the name of the .md file in your registration, and in the metadata at the top of this file. If you're seeing comments/issues, then I'd expect to also see some numbers here.

If your software update hook is configured correctly, you should just need to create a release and then it will be picked up by OctoPrint. Installing from the plugin repository (new installs) using the ...master.zip URL will give you whatever is currently on that branch. I'd advise to develop on a separate branch, and then when you're ready to release you merge to master, and then create a release so existing installs can also update.

(Note I've not actually checked if your update hook is correct, but this would have been done as part of the review which I trust 😉)

@jneilliii
Copy link
Contributor

Yeah, looks like the plugin ids are consistent throughout. Pretty sure we went through all that in the initial review, and what I'm seeing on your plugin's repo for releases appears to match up correctly with what's in setup.py. The only issue I'm currently seeing on the plugin listing is a missing image, because of capitalization related issues, skipto.png instead of SkipTo.png. I'll correct that here in a minute. I do not understand why the github and anonymous usage stats aren't populating, but I suspect it's something related to capitalization as well. @foosel any ideas on that?

@awe-source
Copy link
Author

awe-source commented Sep 12, 2024 via email

@jneilliii
Copy link
Contributor

I don't think it's that because I don't do anything special outside of taking a release like you've done.

@foosel
Copy link
Member

foosel commented Sep 12, 2024

It's nothing you did wrong, there still was a bug in data enrichment here on the plugin repo that I had to touch when this whole stats manipulation happened.

I introduced a new attributes field for that, set that to unset by default, and that caused a bug where I looked at it in the enrichment code, as I tried to use it as a list when in fact it was just set to None. That caused an exception in all plugin listings that had the default attributes: definition, incl. skipto. This has now been fixed and the new page build is up, the plugin now has stats:

https://plugins.octoprint.org/plugins/SkipTo/

@jneilliii
Copy link
Contributor

jneilliii commented Sep 12, 2024

287 instances already, not bad @awe-source

@foosel
Copy link
Member

foosel commented Sep 12, 2024

s/years/instances/g ;)

@jneilliii
Copy link
Contributor

oops...edited.

@awe-source
Copy link
Author

awe-source commented Sep 12, 2024 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants