Git Product home page Git Product logo

mygetdocs's Introduction

MyGet

A complete build suite for creating NuGet packages for miscellaneous CI build environments (think MyGet). How does it work? Simply include the myget.include.ps1 script in your build.ps1 on MyGet and use the provided functions.

Note these scripts will also work without a CI server, for example on your local computer.

Getting started

Checkout the examples.

If you want myget.include.ps1 to work on you local computer you need to have msysgit installed.

You might want to add .buildtools to your .gitignore.

Run unit tests

.\powershelltests.ps1

Build all examples

.\examples\build.all.samples.ps1

Update myget.include.ps1

.\myget.include.ps1 -updateSelf 1

Available functions

The myget.include.ps1 script can be included by your build.ps1 script to make use of the following functions:

Build agent communication

  • MyGet-Write-Diagnostic - writes a diagnostic message to the standard output
  • MyGet-Build-Success - report build success
  • MyGet-Die - report build failure

Utility functions

  • MyGet-Create-Folder - create a new folder

  • MyGet-Build-Clean - recursive clean a folder

  • MyGet-Grep -grep-like function

  • MyGet-Normalize-Path normalize a file system path

  • MyGet-Normalize-Paths normalize an array of file system paths

  • MyGet-EnvironmentVariable returns value of an environment variable

  • MyGet-Set-EnvironmentVariable create / overwrite an existing environment variable value

  • MyGet-BuildRunner - returns the current build runner (empty if not run within MyGet Build Services)

  • MyGet-Package-Version - returns the package version under build (empty if not run within MyGet Build Services)

  • MyGet-NunitExe-Path - path to the NUnit test runner

  • MyGet-XunitExe-Path - path to the XUnit test runner

  • MyGet-TargetFramework-To-Clr Target framework version to clr (e.g v2.0 -> net20)

  • MyGet-TargetFramework-To-Clr Clr to target framework version (e.g net20 -> v2.0)

  • ```MyGet-AssemblyInfo```` Read miscellaneous information from a binary (e.g TargetFramework, Processor architecture ++)

Nuget utility functions

  • MyGet-NugetExe-Path - path to NuGet
  • MyGet-NuGet-Get-PackagesPath returns value of repositorypath attribute in nuget.config for a given project folder

Build steps

  • MyGet-Build-Bootstrap - starts a build (including NuGet package restore)
  • MyGet-Build-Solution - starts a build of a solution file
  • MyGet-Build-Project - starts a build of a project file
  • MyGet-Build-Nupkg - creates a NuGet package based on a specified .nuspec file. The .nuspec can contain additional replacement tokens

Test runners

  • MyGet-TestRunner-Nunit - invoke NUnit
  • MyGet-TestRunner-Xunit - invoke XUnit
  • MyGet-CurlExe-Path - path to Curl
  • MyGet-Squirrel-New-Release - creates a new squirrel release
  • MyGet-Curl-Upload-File - upload files using either scp or sftp (private/public key required)

NuSpec substitutions

** = Provided by MyGet

Variable Description
$outputfolder$ ** bin\$version$\$platform$\$configuration$ -> bin\(x86|x64|AnyCpu)\1.0.0\(v2.0|v3.5|v4.0|v4.5|v4.5.1)
$platform$ ** x86|x64|AnyCpu
$nuspecfolder$ ** Folder where nuspec resides in a project
$configuration$ ** Debug|Release (You decide this value)
$id$ The Assembly name
$version$ The assembly version as specified in the assembly’s AssemblyVersionAttribute. If the assembly’s AssemblyInformationalVersionAttribute is specified, that one is used instead.
$author$ The company as specified in the AssemblyCompanyAttribute.
$description$ The company as specified in the AssemblyCompanyAttribute.

Script parameters

Parameter Description
-packageVersion Package version to build. If building using a CI server, $env:PackageVersion is used instead.
-config Debug, Release (Or custom build configuration name)
-platforms x86, x64, AnyCpu
-targetFrameworks v2.0, v3.5, v4.0, v4.5, v4.5.1
-target Build, Rebuild
-verbosity (MSBuild) Quiet, Minimal, Normal, Detailed, Diagnostic
-clean Set clean to 0 if you wish to avoid gardening of all bin,obj,build folders

License

The MIT License (MIT)

Copyright (c) 2013 Peter Rekdal Sunde

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

mygetdocs's People

Contributors

amandapinchbeck avatar analogrelay avatar credible avatar davidfowl avatar dotnetjunky avatar drakomeep avatar eilon avatar gep13 avatar haacked avatar half-ogre avatar howarddierking avatar jeffhandley avatar jennings avatar jimmym715 avatar kacper-r avatar leemotley avatar maartenba avatar matthcap avatar matthewtheiss avatar mohamedelamry avatar nadjapollard avatar osbornm avatar pete-craig avatar pietergheysens avatar pranavkm avatar scottkoland avatar tomkerkhove avatar trydis avatar xavierdecoster avatar zjrunner avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

mygetdocs's Issues

Reference: Explain Package Sources

Explain the concept of (upstream) package sources and how they relate to package mirroring and referencing, as well as package promotion.

Problem with Advanced Lists section

@gep13 wrote:

Within the Contribute Wiki Article, I "think" the intention was to show that within a list, you could add some content within the list, and then continue the numbering. If that is what is intended, that doesn't seem to be happening.

advanced_lists_error

I had a quick play to try to get this to work, but I couldn't :(

My Markdown Fu is clearly lacking!

Guidance for release channels

People try to do the right thing using Semantic Versioning (semver.org) and applying Continuous Delivery practices. However, it's easy to get stuck without proper guidance, as MyGet is flexible enough to support multiple scenarios.

We should provide guidance on:

  • when to push upstream (e.g. publish to nuget.org)
  • how to set up various release channels by using multiple feeds
  • how to configure MyGet Build Services (convention-based, and scripted)

Example of a scenario we want to explicitly avoid with this guidance:
A package publisher is doing continuous delivery to a single feed for all branches. Following semver, the package publisher is applying proper prerelease tags (e.g. which include the branch name, or a quality label). However, this is not obvious for package consumers connecting to that single feed, as the client tools will not understand the publisher's intent. E.g.: when a package consumer wants to upgrade an already installed package 1.0.0-dev-20170401, and a package with version 1.0.0-issue42 is available on the feed, the client tools will see that package as an available upgrade whilst in reality you've just switched branches...

That's where release channels come into play, which can be set up by configuring e.g. a dev or integration feed, a nightly feed, and a production feed. Any of these can be on MyGet, or upstream. NuGet.org should be considered a production feed in all cases.

New How-To page to fix Issue #13

The following steps were completed in order to try to close out Issue #13

  • Moved existing How-To Article into new How-To folder
  • Added all necessary images to new local Images folder
  • Added steps explaining how to use HTTP POST Hook URL, including images

Where to request new features for MyGet?

Looks like the UserVoice instance for MyGet is down: https://myget.uservoice.com/

Also it looks like the documentation website has not been updated since 2020. In fact, most MyGet related releases and even the public blog seem to be all but halted since around the same time. Is this related to the emergence of alternative platforms such as Azure Artifacts? Would be great to know what is the recommended path for evolution requests going forward.

Reference: Create Feed Settings Page

A reference page documenting each possible feed setting (with references to the pages for the used concepts, eg. build sources, package sources, package source discovery, etc)

Typos and other formatting changes

  • Read through the complete Contributing wiki article and noticed that there were a couple things that weren't correct, so added them all to this commit.
  • As per the instructions, added blank line before HTML markup.
  • Noticed that the heading for blockquotes seemed to be getting indented due to the previous formatting, so added additional line, plus ensured that remaining headings were consistent.

#!RADIUS''

Your free developer account will start you out with access to everything you need to build and test on OneLogin Platform for up to 3 applications and 25 users.

  • Desktop SSO
  • AD/LDAP Directory Integration
  • RADIUS
  • NAPPS - Mobile Identity
  • SCIM
  • Trusted IdP
  • Provisioning

Stay updated. Follow @onelogindev on twitter.

Restoring accidentally deleted packages from backup?

Hello,

I was searching through the Docs and didn't find an answer to a somewhat odd question:

If something went horribly wrong and all packages on a feed were deleted, is there a way to get the lost packages restored from backup?

The closest answer I found was on the FAQ page's Where is my data stored? answer, which mentioned backups.

All free and paid plans are hosted in this location, with backups in the North Europe region, near Dublin, Ireland.

But I read to mean backups of the websites and account information. It didn't seem to indicate that it was keeping backups of the listed packages on a daily or weekly basis. Is that something that is offered?

Maybe this is already answered in the FAQ and I'm just missing it.

[$100] Cash app free money glitch ~! Cash app free money code legit Order ID: (#1934257-1) ATTENDEE Kili Swope PRICE $0.00 TYPE General Admission [$100] Cash app free money glitch ~! Cash app free money code legit Order ID: (#1934257-2) ATTENDEE Halo Asuncion PRICE $0.00 TYPE General Admission [$100] Cash app free money glitch ~! Cash app free money code legit Order ID: (#1934257-3) ATTENDEE Barbara Asuncion PRICE $0.00 TYPE General Admission [$100] Cash app free money glitch ~! Cash app free money code legit Order ID: (#1934257-4) Here are your ticket(s) for [$100] Cash app free money glitch ~! Cash app free money code legit

Case Studies

Proposed steps to submit a case study:

  • create a site\docs\Case-Studies folder
  • add a markdown file in this folder using your company/project name, e.g. chocolatey-gui.md
  • submit a PR with your case study
  • get a free one month Starter plan voucher or a one month extension of your current subscription plan

Build Services Reference Page

@gep13 wrote:

Added an article to cover the use of the %nuget% environment variable within a build script. This should complete Issue #1.
I have stubbed out what I have called a Build Services Reference page. The idea would be to expand on this to cover all the Build Services functionality, and to then include all the other services that are offered by MyGet.

python -m pip install warns about non proper HTML 5 document

When I run python -m pip install --pre --index-url https://www.myget.org/F/apollo3zehn-dev/python/ -r "requirements.txt" --disable-pip-version-check (with a requirements.txt content of nexus-remoting~=1.0.0b12136) I get the following warning on Kubuntu 22.04:

DEPRECATION: The HTML index page being used (https://www.myget.org/F/apollo3zehn-dev/python/nexus-remoting/) is not a proper HTML 5 document. This is in violation of PEP 503 which requires these pages to be well-formed HTML 5 documents. Please reach out to the owners of this index page, and ask them to update this index page to a valid HTML 5 document. pip 22.2 will enforce this behaviour change. Discussion can be found at https://github.com/pypa/pip/issues/10825

Chat & Comment

Hi, I follow this article with you and accept my contribution

A build broken as a result of vulnerabilties does not generate an Error.

When I build an application with the setting DontBreakBuild="false", Build output reports:

========== Build: 0 succeeded, 1 failed, 10 up-to-date, 0 skipped ==========

which is as expected.
However, when I view the Error List in Visual Studio, there is no error. I would be nice if some clue was given.
The warnings could be promoted to errors, or a summary messages could be given.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.