Skip to content

Commit 858aadf

Browse files
author
Elliot Boschwitz
authored
Updated stable download links (#436)
1 parent 881dc01 commit 858aadf

4 files changed

Lines changed: 89 additions & 96 deletions

File tree

‎.bumpversion.cfg‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,5 @@ serialize =
1111
[bumpversion:file:build_scripts/rpm/mssql-cli.spec]
1212

1313
[bumpversion:file:release_scripts/Packages.Microsoft/publish.sh]
14+
15+
[bumpversion:file:doc/installation/README.md]

‎doc/installation/README.md‎

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,23 @@ also be found in the links above.
1919
| Windows (x64) |[.whl][whl-win-x64] |
2020
| Windows (x86) |[.whl][whl-win-x86] |
2121
| macOS 10.12+ |[.whl][whl-macos] |
22+
| Linux (Python Wheel) |[.whl][whl-linux] |
2223
| Ubuntu 14.04+ |[.deb][deb] |
2324
| Debian 8.7+ |[.deb][deb] |
2425
| CentOS 7+ |[.rpm][rpm] |
2526
| Red Hat Enterprise Linux 7+ |[.rpm][rpm] |
2627
| openSUSE |[.rpm][rpm] |
2728
| Fedora 25+ |[.rpm][rpm] |
2829

29-
[deb]: https://packages.microsoft.com/ubuntu/14.04/prod/pool/main/m/mssql-cli/mssql-cli_0.15.0-1_all.deb
30-
[rpm]: https://packages.microsoft.com/rhel/7/prod/mssql-cli-0.15.0-1.el7.x86_64.rpm
31-
[whl-win-x64]: https://files.pythonhosted.org/packages/79/31/1be42f3632a30bb126e02cda4312b797f5f2cdef60b9c62596196a475037/mssql_cli-0.15.0-py2.py3-none-win_amd64.whl
32-
[whl-win-x86]: https://files.pythonhosted.org/packages/21/8c/9829c2094b4f179f9c2f4548b2ba089867f84a3758cb70575ef2a905e877/mssql_cli-0.15.0-py2.py3-none-win32.whl
33-
[whl-macos]: https://files.pythonhosted.org/packages/43/5d/c9af6aec5b491e7b0c5ccf00b4b8062282d6c4cfb4c0417891bd6013e299/mssql_cli-0.15.0-py2.py3-none-macosx_10_11_intel.whl
30+
31+
[deb]: https://packages.microsoft.com/ubuntu/16.04/prod/pool/main/m/mssql-cli/mssql-cli_1.0.0-1_all.deb
32+
33+
[rpm]: https://packages.microsoft.com/centos/7/prod/mssql-cli-1.0.0-1.el7.x86_64.rpm
34+
35+
[whl-win-x64]: https://files.pythonhosted.org/packages/f6/cd/cf9be6175ccc241fd70e11e8d8d6455a630e06ffe1c937034b37e1301b2c/mssql_cli-1.0.0-py2.py3-none-win_amd64.whl
36+
37+
[whl-win-x86]: https://files.pythonhosted.org/packages/08/e0/38d4721bcc0f5f013e8a05b722f55675185dc9e62f460a8615f25e4f0098/mssql_cli-1.0.0-py2.py3-none-win32.whl
38+
39+
[whl-macos]: https://files.pythonhosted.org/packages/14/2f/8ba644a5f8a51048a749441113acd51df282b20ad1497b2aaf599adb10db/mssql_cli-1.0.0-py2.py3-none-macosx_10_11_intel.whl
40+
41+
[whl-linux]: https://files.pythonhosted.org/packages/46/98/257260e7a520291de8168c91bb10778dcae324e2a236e856dd3cce7fe0b1/mssql_cli-1.0.0-py2.py3-none-manylinux1_x86_64.whl

‎doc/installation/linux.md‎

Lines changed: 49 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -3,55 +3,58 @@ Stable installations of mssql-cli on Linux are hosted in the [Microsoft Linux So
33

44
[**Debian-based**](#Debian-based)
55
- [**Ubuntu**](#Ubuntu)
6-
- [Ubuntu 14.04 (Trusty)](#ubuntu-1404-Trusty)
76
- [Ubuntu 16.04 (Xenial)](#ubuntu-1604-Xenial)
7+
- [Ubuntu 18.04 (Bionic)](#ubuntu-1804-Bionic)
88
- [**Debian**](#Debian)
99
- [Debian 8](#debian-8)
1010
- [Debian 9](#debian-9)
1111

1212
[**RPM-based**](#RPM-based)
13-
- [**CentOS/RHEL**](#CentOSRHEL)
13+
- [**CentOS**](#CentOS)
1414
- [CentOS 7](#centos-7)
15-
- [Red Hat Enterprise Linux (RHEL) 7](#red-hat-enterprise-linux-rhel-7)
16-
- [**openSUSE**](#opensuse)
17-
- [openSUSE 42.2](#opensuse-422)
18-
- [**Fedora**](#fedora)
19-
- [Fedora 25](#fedora-25)
20-
- [Fedora 26](#fedora-26)
15+
- [CentOS 8](#centos-8)
16+
- [**Red Hat Enterprise Linux**](#Red-Hat-Enterprise-Linux)
17+
- [RHEL 7](#RHEL-7)
2118

2219

2320
## Debian-based
2421

2522
### Ubuntu
2623

27-
#### Ubuntu 14.04 (Trusty)
24+
#### Ubuntu 16.04 (Xenial)
2825
```sh
2926
# Import the public repository GPG keys
3027
curl https://packages.microsoft.com/keys/microsoft.asc | sudo apt-key add -
3128

3229
# Register the Microsoft Ubuntu repository
33-
sudo apt-add-repository https://packages.microsoft.com/ubuntu/14.04/prod
30+
sudo apt-add-repository https://packages.microsoft.com/ubuntu/16.04/prod
3431

3532
# Update the list of products
3633
sudo apt-get update
3734

3835
# Install mssql-cli
3936
sudo apt-get install mssql-cli
37+
38+
# Install missing dependencies
39+
sudo apt-get install -f
4040
```
4141

42-
#### Ubuntu 16.04 (Xenial)
42+
#### Ubuntu 18.04 (Bionic)
4343
```sh
4444
# Import the public repository GPG keys
4545
curl https://packages.microsoft.com/keys/microsoft.asc | sudo apt-key add -
4646

4747
# Register the Microsoft Ubuntu repository
48-
sudo apt-add-repository https://packages.microsoft.com/ubuntu/16.04/prod
48+
sudo apt-add-repository https://packages.microsoft.com/ubuntu/18.04/prod
4949

5050
# Update the list of products
5151
sudo apt-get update
5252

5353
# Install mssql-cli
5454
sudo apt-get install mssql-cli
55+
56+
# Install missing dependencies
57+
sudo apt-get install -f
5558
```
5659

5760
### Debian
@@ -70,6 +73,9 @@ sudo apt-get update
7073

7174
# Install mssql-cli
7275
sudo apt-get install mssql-cli
76+
77+
# Install missing dependencies
78+
sudo apt-get install -f
7379
```
7480

7581
#### Debian 9
@@ -85,6 +91,9 @@ sudo apt-get update
8591

8692
# Install mssql-cli
8793
sudo apt-get install mssql-cli
94+
95+
# Install missing dependencies
96+
sudo apt-get install -f
8897
```
8998

9099
### Upgrade on Ubuntu/Debian
@@ -97,84 +106,54 @@ To uninstall mssql-cli, call `sudo apt-get remove mssql-cli`.
97106

98107
## RPM-based
99108

100-
### CentOS/RHEL
109+
### CentOS
101110

102111
#### CentOS 7
103112
> This package also works on Oracle Linux 7.
104113
105114
```sh
115+
# Import the public repository GPG keys
106116
sudo rpm --import https://packages.microsoft.com/keys/microsoft.asc
107-
sudo curl -o /etc/yum.repos.d/mssql-cli.repo https://packages.microsoft.com/config/rhel/7/prod.repo
108-
sudo yum install mssql-cli
109-
```
110117

111-
#### Red Hat Enterprise Linux (RHEL) 7
112-
```sh
113-
sudo rpm --import https://packages.microsoft.com/keys/microsoft.asc
114-
curl https://packages.microsoft.com/config/rhel/7/prod.repo | sudo tee /etc/yum.repos.d/microsoft.repo
118+
# Register the Microsoft product feed
119+
curl https://packages.microsoft.com/config/centos/7/prod.repo > /etc/yum.repos.d/msprod.repo
120+
121+
# Install dependencies and mssql-cli
122+
sudo yum install libunwind
115123
sudo yum install mssql-cli
116124
```
117125

118-
### Upgrade on CentOS/RHEL
119-
After registering the Microsoft repository once as superuser,
120-
from then on, you just need to use `sudo yum update mssql-cli` to update it.
121-
122-
### Uninstall on CentOS/RHEL
123-
To uninstall mssql-cli, call `sudo yum remove mssql-cli`.
124-
125-
126-
## openSUSE
127-
128-
### openSUSE
129-
130-
#### openSUSE 42.2
131-
132-
mssql-cli for Linux is published to official Microsoft repositories for easy installation (and updates).
133-
126+
#### CentOS 8
134127
```sh
135-
# Add openSUSE repository feed
136-
sudo zypper addrepo https://download.opensuse.org/repositories/server:monitoring/openSUSE_Leap_42.2/server:monitoring.repo
137-
138-
# Add the Microsoft Product feed
139-
sudo zypper addrepo -fc https://packages.microsoft.com/config/opensuse/42.2/prod.repo
140-
141-
# Add Microsoft repository key
128+
# Import the public repository GPG keys
142129
sudo rpm --import https://packages.microsoft.com/keys/microsoft.asc
143130

144-
# Update the list of products
145-
sudo zypper update
131+
# Register the Microsoft product feed
132+
curl https://packages.microsoft.com/config/cenots/8/prod.repo > /etc/yum.repos.d/msprod.repo
146133

147-
# Install system level component and mssql-cli
148-
sudo zypper install libffi-devel
149-
sudo zypper install mssql-cli
134+
# Install dependencies and mssql-cli
135+
sudo yum install libunwind
136+
sudo yum install mssql-cli
150137
```
151138

139+
### Red Hat Enterprise Linux
152140

153-
## Fedora
154-
155-
### Fedora
156-
157-
#### Fedora 25
158-
141+
#### RHEL 7
159142
```sh
160-
# Register the Microsoft RedHat repository
161-
sudo curl -o /etc/yum.repos.d/mssql-cli.repo https://packages.microsoft.com/config/rhel/7/prod.repo
143+
# Import the public repository GPG keys
144+
sudo rpm --import https://packages.microsoft.com/keys/microsoft.asc
162145

163-
# Update the list of products
164-
sudo dnf update
146+
# Register the Microsoft product feed
147+
curl https://packages.microsoft.com/config/rhel/7/prod.repo > /etc/yum.repos.d/msprod.repo
165148

166-
# Install mssql-cli
167-
sudo dnf install mssql-cli
149+
# Install dependencies and mssql-cli
150+
sudo yum install libunwind
151+
sudo yum install mssql-cli
168152
```
169153

170-
#### Fedora 26
171-
```sh
172-
# Register the Microsoft RedHat repository
173-
sudo curl -o /etc/yum.repos.d/mssql-cli.repo https://packages.microsoft.com/config/rhel/7/prod.repo
174-
175-
# Update the list of products
176-
sudo dnf update
154+
### Upgrade on CentOS/RHEL
155+
After registering the Microsoft repository once as superuser,
156+
from then on, you just need to use `sudo yum update mssql-cli` to update it.
177157

178-
# Install mssql-cli
179-
sudo dnf install mssql-cli
180-
```
158+
### Uninstall on CentOS/RHEL
159+
To uninstall mssql-cli, call `sudo yum remove mssql-cli`.

‎doc/release_guide.md‎

Lines changed: 25 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,30 @@
1-
mssql-cli Release Guide
2-
========================================
3-
# Table of Contents
1+
# mssql-cli Release Guide
2+
3+
## Table of Contents
44
1. [Requirements](#requirements)
55
2. [Creating a New Version](#creating-a-new-version)
66
3. [Generating Release Files](#generating-release-files)
77
4. [Publishing Release Files](#publishing-release-files)
8-
5. [Installing Specific Release Files from Azure Storage](#installing-specific-release-files-from-azure-storage)
8+
5. [Update Links in Installation Readme](#Update-Links-in-Installation-Readme)
9+
6. [Installing Specific Release Files from Azure Storage](#installing-specific-release-files-from-azure-storage)
910

1011

11-
# Requirements
12-
## Installing Dependencies
12+
## Requirements
13+
### Installing Dependencies
1314
1. Add `<clone_root>` to your PYTHONPATH environment variable:
14-
#### Windows
15+
##### Windows
1516
```
1617
set PYTHONPATH=<clone_root>;%PYTHONPATH%
1718
```
18-
#### OSX/Ubuntu (bash)
19+
##### OSX/Ubuntu (bash)
1920
```
2021
export PYTHONPATH=<clone_root>:${PYTHONPATH}
2122
```
2223
2. Install the dependencies:
2324
```
2425
python <clone_root>/dev_setup.py
2526
```
26-
## Azure Storage Account Configuration
27+
### Azure Storage Account Configuration
2728
1. The Azure Storage account needs a container named **daily**.
2829
2930
2. A sub folder named **mssql-cli** under the previous container.
@@ -40,7 +41,7 @@ mssql-cli Release Guide
4041
export AZURE_STORAGE_CONNECTION_STRING='<connection_string>'
4142
```
4243
43-
# Creating a New Version
44+
## Creating a New Version
4445
The versioning format for `mssql-cli` uses the following naming scheme:
4546
4647
Versioning schema: {major}.{minor}.{patch}
@@ -56,20 +57,20 @@ Check-in changes after running `bumpversion` and **validating the build output f
5657
**Note**: bumpversion does not allow version bumping if your workspace has pending changes. This is to protect against any manual updates that may have been made which can lead to inconsistent versions across files. If you know what you are doing you can override this by appending `--allow-dirty` to the bumpversion command.
5758
5859
59-
# Generating Release Files
60+
## Generating Release Files
6061
The steps below outline how to create wheel and source distribution files to publish to Azure Storage, and eventually PyPI for official release.
6162
62-
## Daily Release Configuration
63+
### Daily Release Configuration
6364
Release files are generated for daily release by default, as long as the `MSSQL_CLI_OFFICIAL_BUILD` environment variable is **not** set to `True`.
6465
65-
## Official Release Configuration
66+
### Official Release Configuration
6667
The `MSSQL_CLI_OFFICIAL_BUILD` enviornment variable must be set to `True` before build files are created. Although this step can be completed locally, we recommend running production pipelines in Azure DevOps with the enviornment variable set for each run.
6768
6869
If configured locally, instructions per OS are as follows:
6970
- **Windows**: `set MSSQL_CLI_OFFICIAL_BUILD=True`
7071
- **macOS/Linux**: `export MSSQL_CLI_OFFICIAL_BUILD=True`
7172
72-
## Building Release Files
73+
### Building Release Files
7374
To build a release package with wheel and source distribution files for the current platform, run:
7475
```
7576
python build.py build
@@ -78,19 +79,19 @@ Distribution files will be generated in `./dist/`. These files are eventually pu
7879
7980
**Note:** source distribution files will only get created on macOS. This platform was arbitrarily chosen to prevent redundant copies of source distributions when `build` is run on each platform in Azure DevOps.
8081
81-
# Publishing Release Files
82+
## Publishing Release Files
8283
The following instructions outline how to publish release files once generated n the `./dist/` folder.
8384
84-
## Publishing Daily Builds to Azure Storage
85+
### Publishing Daily Builds to Azure Storage
8586
Publish build to daily storage account by calling:
8687
```
8788
python release.py publish_daily
8889
```
8990
90-
## Publishing Official Builds
91+
### Publishing Official Builds
9192
The steps below outline how to build official builds and publish to PyPI.
9293
93-
### Configuration with PyPI
94+
#### Configuration with PyPI
9495
A `.pypirc` configuration file must be created in order to publish to PyPI. Place in the following user directories.
9596
9697
Examples for each OS:
@@ -115,7 +116,7 @@ username: sqlcli
115116
password: <Get Password from Azure Key Vault>
116117
```
117118
118-
### Test Publishing with TestPyPI
119+
#### Test Publishing with TestPyPI
119120
120121
[TestPyPi](https://test.pypi.org) can be used to test distribution before going to production. To test publishing to TestPyPI, use the above `.pypirc` file and call:
121122
```
@@ -124,7 +125,7 @@ twine upload --repository testpypi dist/*
124125
125126
[Click here](https://packaging.python.org/guides/using-testpypi/) to view TestPyPI docs.
126127
127-
### Publishing Official Release Files to PyPI
128+
#### Publishing Official Release Files to PyPI
128129
**Important: ensure that the build is uploaded from macOS.**
129130
130131
Follow the instructions below to publish a new release to PyPI after official release build files have been published to Azure Storage:
@@ -139,7 +140,10 @@ Follow the instructions below to publish a new release to PyPI after official re
139140
python release.py publish_official
140141
```
141142
142-
# Installing Specific Release Files from Azure Storage
143+
## Update Links in Installation Readme
144+
Once a new official version has been published, please update the links in the [installation readme](https://github.com/dbcli/mssql-cli/tree/master/doc/installation).
145+
146+
## Installing Specific Release Files from Azure Storage
143147
To test the installation a wheel or source distribution, execute the following from `<clone_root>`, replacing values for `<version>` and `<timestamp>`:
144148
```
145149
pip install --no-index -i ./dist/mssql_cli-<version>.dev<timestamp>-py2.py3-none-win_amd64.whl

0 commit comments

Comments
 (0)