Opened 3 years ago

Closed 3 years ago

#55448 closed enhancement (fixed)

Document github portgroup in guide

Reported by: emcrisostomo (Enrico Maria Crisostomo) Owned by:
Priority: Normal Milestone:
Component: guide Version:
Keywords: Cc:
Port:

Description (last modified by ryandesign (Ryan Schmidt))

While updating the sysutils/fswatch port, I decided to add the livecheck configuration. I searched the guide (section 5.8) to see whether there was some builtin functionality for github but the only mentions I found are referring to mirror sites (freecode.com, sourceforge.net, /code.google.com). A search came up with the following MacPorts ticket:

#53940

As suggested in this ticket, I tried to simply add the following line to the Portfile and it appears to be working fine:

livecheck.url   ${github.homepage}/releases/latest

Shouldn't the guide be updated in order to reflect this feature? I believe this is an important feature, given the relevance of Github nowadays.

Change History (3)

comment:1 Changed 3 years ago by ryandesign (Ryan Schmidt)

Description: modified (diff)
Summary: MacPorts guide makes no mention of livecheck built-in functionality for githubDocument github portgroup in guide

Yes, the github portgroup is not documented in the guide. Yes, it should be.

For now, the only documentation for the github portgroup is in comments in the portgroup file itself.

comment:2 Changed 3 years ago by emcrisostomo (Enrico Maria Crisostomo)

Thanks you very much Ryan.

I've created the following pull request (https://github.com/macports/macports-guide/pull/12) in order to contribute documentation of this portgroup to the macports guide. As you'll see, I've heavily used the documentation in the portgroup file itself. Since English is not my native language, please feel free to provide any feedback that you consider appropriate.

comment:3 Changed 3 years ago by ryandesign (Ryan Schmidt)

Resolution: fixed
Status: newclosed
Type: defectenhancement

Thanks! The PR was merged.

Note: See TracTickets for help on using tickets.